-#
-# ============LICENSE_START=======================================================
-# org.onap.aai
-# ================================================================================
-# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
-# ================================================================================
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.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.
-# ============LICENSE_END=========================================================
-#
-# ECOMP is a trademark and service mark of AT&T Intellectual Property.
-#
-
swagger: "2.0"
info:
description: |
+
+ [Differences versus the previous schema version](apidocs/aai_swagger_v8.diff)
+
Copyright © 2017 AT&T Intellectual Property. All rights reserved.
Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: target-pe
in: path
description: The Target provider edge router
required: true
type: string
+ example: __TARGET-PE__
- name: availability-zone-name
in: path
description: Name of the availability zone
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: target-pe
in: path
description: The Target provider edge router
required: true
type: string
+ example: __TARGET-PE__
- name: availability-zone-name
in: path
description: Name of the availability zone
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/ctag-pool"
+ $ref: "#/getDefinitions/ctag-pool"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: target-pe
in: path
description: The Target provider edge router
required: true
type: string
+ example: __TARGET-PE__
- name: availability-zone-name
in: path
description: Name of the availability zone
required: true
type: string
- - name: data-center-code
- in: query
- description: Data center code which can be an alternate way to identify a complex
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
- in: query
- description: URL of the keystone identity service
- required: false
- type: string
+ example: __AVAILABILITY-ZONE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing ctag-pool
- description: create or update an existing ctag-pool
+ 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
consumes:
- application/json
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: target-pe
in: path
description: The Target provider edge router
required: true
type: string
+ example: __TARGET-PE__
- name: availability-zone-name
in: path
description: Name of the availability zone
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: body
in: body
- description: ctag-pool object that needs to be created or updated
+ description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
required: true
schema:
$ref: "#/definitions/ctag-pool"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing ctag-pool
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: ctag-pool object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ctag-pool"
delete:
tags:
- CloudInfrastructure
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: target-pe
in: path
description: The Target provider edge router
required: true
type: string
+ example: __TARGET-PE__
- name: availability-zone-name
in: path
description: Name of the availability zone
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/ctag-pools"
+ $ref: "#/getDefinitions/ctag-pools"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
- - name: data-center-code
- in: query
- description: Data center code which can be an alternate way to identify a complex
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
+ example: __PHYSICAL-LOCATION-ID__
+ - name: availability-zone-name
in: query
- description: URL of the keystone identity service
+ description:
required: false
type: string
/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
/cloud-infrastructure/complexes/complex/{physical-location-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/complex"
+ $ref: "#/getDefinitions/complex"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
- - name: data-center-code
- in: query
- description: Data center code which can be an alternate way to identify a complex
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
- in: query
- description: URL of the keystone identity service
- required: false
- type: string
+ example: __PHYSICAL-LOCATION-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing complex
- description: create or update an existing complex
+ 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
consumes:
- application/json
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: body
in: body
- description: complex object that needs to be created or updated
+ description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
required: true
schema:
$ref: "#/definitions/complex"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing complex
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: body
+ in: body
+ description: complex object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/complex"
delete:
tags:
- CloudInfrastructure
description: Unique identifier for physical location, e.g., CLLI
required: true
type: string
+ example: __PHYSICAL-LOCATION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/complexes"
+ $ref: "#/getDefinitions/complexes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: data-center-code
+ in: query
+ description:
+ required: false
+ type: string
+ - name: complex-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: identity-url
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
put:
tags:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: volume-group-id
in: path
description: Unique ID of volume-group.
required: true
type: string
+ example: __VOLUME-GROUP-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: volume-group-id
in: path
description: Unique ID of volume-group.
required: true
type: string
+ example: __VOLUME-GROUP-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/volume-group"
+ $ref: "#/getDefinitions/volume-group"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: volume-group-id
in: path
description: Unique ID of volume-group.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: volume-group-name
- in: query
- description: Name of the volume group.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this volume-group
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
+ example: __VOLUME-GROUP-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing volume-group
- description: create or update an existing volume-group
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: volume-group-id
in: path
description: Unique ID of volume-group.
required: true
type: string
+ example: __VOLUME-GROUP-ID__
- name: body
in: body
- description: volume-group object that needs to be created or updated
+ description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
required: true
schema:
$ref: "#/definitions/volume-group"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing volume-group
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: body
+ in: body
+ description: volume-group object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/volume-group"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: volume-group-id
in: path
description: Unique ID of volume-group.
required: true
type: string
+ example: __VOLUME-GROUP-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/volume-groups"
+ $ref: "#/getDefinitions/volume-groups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: volume-group-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/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:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: volume-id
in: path
description: Unique ID of block storage volume relative to the vserver.
required: true
type: string
+ example: __VOLUME-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: volume-id
in: path
description: Unique ID of block storage volume relative to the vserver.
required: true
type: string
+ example: __VOLUME-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/volume"
+ $ref: "#/getDefinitions/volume"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: volume-id
in: path
description: Unique ID of block storage volume relative to the vserver.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
+ example: __VOLUME-ID__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing volume
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- put:
+ example: __VOLUME-ID__
+ - name: body
+ in: body
+ description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
+ required: true
+ schema:
+ $ref: "#/definitions/volume"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing volume
- description: create or update an existing volume
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ summary: update an existing volume
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: volume-id
in: path
description: Unique ID of block storage volume relative to the vserver.
required: true
type: string
+ example: __VOLUME-ID__
- name: body
in: body
- description: volume object that needs to be created or updated
+ description: volume object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/volume"
+ $ref: "#/patchDefinitions/volume"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: volume-id
in: path
description: Unique ID of block storage volume relative to the vserver.
required: true
type: string
+ example: __VOLUME-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/volumes"
+ $ref: "#/getDefinitions/volumes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
+ example: __VSERVER-ID__
+ - name: volume-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
put:
tags:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
/cloud-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:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/cloud-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:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/cloud-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/cloud-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- put:
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ summary: update an existing vlan
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-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:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/cloud-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __PCI-ID__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
- put:
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ summary: update an existing sriov-vf
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: tenant-id
- in: path
- description: Unique id relative to the cloud-region.
- required: true
- type: string
- - name: vserver-id
- in: path
- description: Unique identifier for this vserver relative to its tenant
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- /cloud-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: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description:
+ required: false
+ type: string
+ /cloud-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: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/cloud-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:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/cloud-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/cloud-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
- type: string
- /cloud-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:
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- - name: vserver-name
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
in: query
- description: Name of vserver
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: 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: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
+ example: __INTERFACE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
+ example: __VSERVER-ID__
+ - name: interface-name
in: query
- description: Readable name of tenant
+ description:
required: false
type: string
- - name: vserver-name
+ - name: interface-id
in: query
- description: Name of vserver
+ description:
required: false
type: string
- - name: vserver-name2
+ - name: macaddr
in: query
- description: Alternative name of vserver
+ description:
required: false
type: string
- - name: prov-status
+ - name: network-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vserver"
+ $ref: "#/getDefinitions/vserver"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
- type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
+ example: __VSERVER-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing vserver
- description: create or update an existing vserver
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: body
in: body
- description: vserver object that needs to be created or updated
+ description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
required: true
schema:
$ref: "#/definitions/vserver"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vserver
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: body
+ in: body
+ description: vserver object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vserver"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: vserver-id
in: path
description: Unique identifier for this vserver relative to its tenant
required: true
type: string
+ example: __VSERVER-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vservers"
+ $ref: "#/getDefinitions/vservers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
- - name: cloud-type
+ example: __TENANT-ID__
+ - name: vserver-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: vserver-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
- - name: tenant-name
+ - name: vserver-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
in: query
- description: Readable name of tenant
+ description:
required: false
type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
put:
tags:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/tenant"
+ $ref: "#/getDefinitions/tenant"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
+ example: __TENANT-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing tenant
- description: create or update an existing tenant
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: body
in: body
- description: tenant object that needs to be created or updated
+ description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
required: true
schema:
$ref: "#/definitions/tenant"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing tenant
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: body
+ in: body
+ description: tenant object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/tenant"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: tenant-id
in: path
description: Unique id relative to the cloud-region.
required: true
type: string
+ example: __TENANT-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/tenants"
+ $ref: "#/getDefinitions/tenants"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: tenant-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: flavor-id
in: path
description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
+ example: __FLAVOR-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: flavor-id
in: path
description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
+ example: __FLAVOR-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/flavor"
+ $ref: "#/getDefinitions/flavor"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: flavor-id
in: path
description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: flavor-name
- in: query
- description: Flavor name
- required: false
- type: string
+ example: __FLAVOR-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing flavor
- description: create or update an existing flavor
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: flavor-id
in: path
description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
+ example: __FLAVOR-ID__
- name: body
in: body
- description: flavor object that needs to be created or updated
+ description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
required: true
schema:
$ref: "#/definitions/flavor"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing flavor
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: body
+ in: body
+ description: flavor object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/flavor"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: flavor-id
in: path
description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
+ example: __FLAVOR-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/flavors"
+ $ref: "#/getDefinitions/flavors"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: flavor-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: group-id
in: path
description: Group id, expected to be unique across cloud-region.
required: true
type: string
+ example: __GROUP-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: group-id
in: path
description: Group id, expected to be unique across cloud-region.
required: true
type: string
+ example: __GROUP-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/group-assignment"
+ $ref: "#/getDefinitions/group-assignment"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: group-id
in: path
description: Group id, expected to be unique across cloud-region.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: group-type
- in: query
- description: Group type - the type of group this instance refers to
- required: false
- type: string
- - name: group-name
- in: query
- description: Group name - name assigned to the group
- required: false
- type: string
+ example: __GROUP-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing group-assignment
- description: create or update an existing group-assignment
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: group-id
in: path
description: Group id, expected to be unique across cloud-region.
required: true
type: string
+ example: __GROUP-ID__
- name: body
in: body
- description: group-assignment object that needs to be created or updated
+ description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
required: true
schema:
$ref: "#/definitions/group-assignment"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing group-assignment
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: body
+ in: body
+ description: group-assignment object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/group-assignment"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: group-id
in: path
description: Group id, expected to be unique across cloud-region.
required: true
type: string
+ example: __GROUP-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/group-assignments"
+ $ref: "#/getDefinitions/group-assignments"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: group-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: group-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: group-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: snapshot-id
in: path
description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: snapshot-id
in: path
description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
+ example: __SNAPSHOT-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/snapshot"
+ $ref: "#/getDefinitions/snapshot"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: snapshot-id
in: path
description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: snapshot-name
- in: query
- description: Snapshot name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
- - name: prev-snapshot-id
- in: query
- description: This field contains the UUID of the previous snapshot (if any).
- required: false
- type: string
+ example: __SNAPSHOT-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing snapshot
- description: create or update an existing snapshot
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: snapshot-id
in: path
description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: snapshot object that needs to be created or updated
+ description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
required: true
schema:
$ref: "#/definitions/snapshot"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing snapshot
- description: delete an existing snapshot
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ summary: update an existing snapshot
+ 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
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: snapshot-id
in: path
description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
- get:
- tags:
- - CloudInfrastructure
- summary: returns snapshots
- description: returns snapshots
- operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/snapshots"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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
- type: string
- - name: cloud-region-id
- in: path
- description: Identifier used by the vendor for the region. Second part of composite key
- required: true
- type: string
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: snapshot object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/snapshot"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ summary: delete an existing snapshot
+ description: delete an existing snapshot
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: image-id
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
in: path
- description: Image id, expected to be unique across cloud region
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
+ example: __SNAPSHOT-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
get:
tags:
- CloudInfrastructure
- summary: returns metadatum
- description: returns metadatum
- operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ summary: returns snapshots
+ description: returns snapshots
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/getDefinitions/snapshots"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- - name: metaname
- in: path
- required: true
- type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
- - name: image-name
+ - name: snapshot-name
in: query
- description: Image name
+ description:
required: false
type: string
- name: application
in: query
- description: The application that the image instantiates.
+ description:
required: false
type: string
- name: application-vendor
in: query
- description: The vendor of the application.
+ description:
required: false
type: string
- name: application-version
in: query
- description: The version of the application.
+ description:
+ required: false
+ type: string
+ - name: prev-snapshot-id
+ in: query
+ description:
required: false
type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
+ example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing metadatum
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
required: true
schema:
$ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing metadatum
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
+ example: __IMAGE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
+ example: __IMAGE-ID__
+ - name: metaname
in: query
- description: The version of the application.
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/image"
+ $ref: "#/getDefinitions/image"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
+ example: __IMAGE-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing image
- description: create or update an existing image
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
+ example: __IMAGE-ID__
- name: body
in: body
- description: image object that needs to be created or updated
+ description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
required: true
schema:
$ref: "#/definitions/image"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing image
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: image object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/image"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: image-id
in: path
description: Image id, expected to be unique across cloud region
required: true
type: string
+ example: __IMAGE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/images"
+ $ref: "#/getDefinitions/images"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: image-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: image-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-vendor
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: switch-name
in: path
description: DVS switch name
required: true
type: string
+ example: __SWITCH-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: switch-name
in: path
description: DVS switch name
required: true
type: string
+ example: __SWITCH-NAME__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/dvs-switch"
+ $ref: "#/getDefinitions/dvs-switch"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: switch-name
in: path
description: DVS switch name
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: vcenter-url
- in: query
- description: URL used to reach the vcenter
- required: false
- type: string
+ example: __SWITCH-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing dvs-switch
- description: create or update an existing dvs-switch
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: switch-name
in: path
description: DVS switch name
required: true
type: string
+ example: __SWITCH-NAME__
- name: body
in: body
- description: dvs-switch object that needs to be created or updated
+ description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
required: true
schema:
$ref: "#/definitions/dvs-switch"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing dvs-switch
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: body
+ in: body
+ description: dvs-switch object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/dvs-switch"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: switch-name
in: path
description: DVS switch name
required: true
type: string
+ example: __SWITCH-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/dvs-switches"
+ $ref: "#/getDefinitions/dvs-switches"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: vcenter-url
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: network-uuid
in: path
description: UUID of the network. Unique across a cloud-region
required: true
type: string
+ example: __NETWORK-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: network-uuid
in: path
description: UUID of the network. Unique across a cloud-region
required: true
type: string
+ example: __NETWORK-UUID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/oam-network"
+ $ref: "#/getDefinitions/oam-network"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: network-uuid
in: path
description: UUID of the network. Unique across a cloud-region
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network.
- required: false
- type: string
- - name: cvlan-tag
- in: query
- description: cvlan-id
- required: false
- type: integer
- format: int64
+ example: __NETWORK-UUID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing oam-network
- description: create or update an existing oam-network
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: network-uuid
in: path
description: UUID of the network. Unique across a cloud-region
required: true
type: string
+ example: __NETWORK-UUID__
- name: body
in: body
- description: oam-network object that needs to be created or updated
+ description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
required: true
schema:
$ref: "#/definitions/oam-network"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing oam-network
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: oam-network object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/oam-network"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: network-uuid
in: path
description: UUID of the network. Unique across a cloud-region
required: true
type: string
+ example: __NETWORK-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/oam-networks"
+ $ref: "#/getDefinitions/oam-networks"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: network-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
+ - name: cvlan-tag
+ in: query
+ description:
+ required: false
+ type: integer
+ format: int64
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
put:
tags:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: availability-zone-name
in: path
description: Name of the availability zone. Unique across a cloud region
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: availability-zone-name
in: path
description: Name of the availability zone. Unique across a cloud region
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/availability-zone"
+ $ref: "#/getDefinitions/availability-zone"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: availability-zone-name
in: path
description: Name of the availability zone. Unique across a cloud region
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
+ example: __AVAILABILITY-ZONE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing availability-zone
- description: create or update an existing availability-zone
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: availability-zone-name
in: path
description: Name of the availability zone. Unique across a cloud region
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: body
in: body
- description: availability-zone object that needs to be created or updated
+ description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
required: true
schema:
$ref: "#/definitions/availability-zone"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing availability-zone
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: availability-zone object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/availability-zone"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: availability-zone-name
in: path
description: Name of the availability zone. Unique across a cloud region
required: true
type: string
+ example: __AVAILABILITY-ZONE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/availability-zones"
+ $ref: "#/getDefinitions/availability-zones"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/cloud-region"
+ $ref: "#/getDefinitions/cloud-region"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., DCP, LCP)
- required: false
- type: string
+ example: __CLOUD-REGION-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing cloud-region
- description: create or update an existing cloud-region
+ 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
consumes:
- application/json
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: body
in: body
- description: cloud-region object that needs to be created or updated
+ description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
required: true
schema:
$ref: "#/definitions/cloud-region"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing cloud-region
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: body
+ in: body
+ description: cloud-region object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/cloud-region"
delete:
tags:
- CloudInfrastructure
description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
+ example: __CLOUD-OWNER__
- name: cloud-region-id
in: path
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ example: __CLOUD-REGION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/cloud-regions"
+ $ref: "#/getDefinitions/cloud-regions"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: query
+ description:
+ required: false
+ type: string
+ - name: cloud-region-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: cloud-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
put:
tags:
description: Unique name of network profile.
required: true
type: string
+ example: __NM-PROFILE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique name of network profile.
required: true
type: string
+ example: __NM-PROFILE-NAME__
/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-profile"
+ $ref: "#/getDefinitions/network-profile"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique name of network profile.
required: true
type: string
+ example: __NM-PROFILE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing network-profile
- description: create or update an existing network-profile
+ 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
consumes:
- application/json
description: Unique name of network profile.
required: true
type: string
+ example: __NM-PROFILE-NAME__
- name: body
in: body
- description: network-profile object that needs to be created or updated
+ description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
required: true
schema:
$ref: "#/definitions/network-profile"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing network-profile
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: network-profile object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/network-profile"
delete:
tags:
- CloudInfrastructure
description: Unique name of network profile.
required: true
type: string
+ example: __NM-PROFILE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-profiles"
+ $ref: "#/getDefinitions/network-profiles"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
put:
tags:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
put:
tags:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
- type: string
- /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:
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: l3-interface-ipv6-address
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ type: string
+ /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: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- CloudInfrastructure
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: pserver-id
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: vf-vlan-filter
in: query
- description: alternative pserver name
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: hostname
- in: path
- description: Value from executing hostname on the compute node.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- put:
- tags:
- - CloudInfrastructure
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: hostname
- in: path
- description: Value from executing hostname on the compute node.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: pserver-id
+ example: __INTERFACE-NAME__
+ - name: interface-name
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
+ - name: interface-id
in: query
+ description:
required: false
- type: boolean
- - name: pserver-name2
+ type: string
+ - name: macaddr
in: query
- description: alternative pserver name
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interface"
+ $ref: "#/getDefinitions/p-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing p-interface
- description: create or update an existing p-interface
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: p-interface object that needs to be created or updated
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing p-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interfaces"
+ $ref: "#/getDefinitions/p-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ example: __HOSTNAME__
+ - name: interface-name
in: query
- description: alternative pserver name
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
- type: string
- /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:
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- CloudInfrastructure
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: pserver-id
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: vf-vlan-filter
in: query
- description: alternative pserver name
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- CloudInfrastructure
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l-interface"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: hostname
- in: path
- description: Value from executing hostname on the compute node.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- put:
- tags:
- - CloudInfrastructure
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: hostname
- in: path
- description: Value from executing hostname on the compute node.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: pserver-id
+ example: __INTERFACE-NAME__
+ - name: interface-name
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
+ - name: interface-id
in: query
+ description:
required: false
- type: boolean
- - name: pserver-name2
+ type: string
+ - name: macaddr
in: query
- description: alternative pserver name
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/getDefinitions/lag-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: lag-interface object that needs to be created or updated
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing lag-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $ref: "#/getDefinitions/lag-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ example: __HOSTNAME__
+ - name: interface-name
in: query
- description: alternative pserver name
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/pserver"
+ $ref: "#/getDefinitions/pserver"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Value from executing hostname on the compute node.
required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
- type: string
+ example: __HOSTNAME__
put:
tags:
- CloudInfrastructure
summary: create or update an existing pserver
- description: create or update an existing pserver
+ 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
consumes:
- application/json
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: body
in: body
- description: pserver object that needs to be created or updated
+ description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
required: true
schema:
$ref: "#/definitions/pserver"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing pserver
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: body
+ in: body
+ description: pserver object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/pserver"
delete:
tags:
- CloudInfrastructure
description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/pservers"
+ $ref: "#/getDefinitions/pservers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: query
+ description:
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
put:
tags:
description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/virtual-data-center"
+ $ref: "#/getDefinitions/virtual-data-center"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique ID of the vdc
required: true
type: string
- - name: vdc-name
- in: query
- description: Name of the virtual data center
- required: false
- type: string
+ example: __VDC-ID__
put:
tags:
- CloudInfrastructure
summary: create or update an existing virtual-data-center
- description: create or update an existing virtual-data-center
+ 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
consumes:
- application/json
description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: body
in: body
- description: virtual-data-center object that needs to be created or updated
+ description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
required: true
schema:
$ref: "#/definitions/virtual-data-center"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing virtual-data-center
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: body
+ in: body
+ description: virtual-data-center object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/virtual-data-center"
delete:
tags:
- CloudInfrastructure
description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/virtual-data-centers"
+ $ref: "#/getDefinitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vdc-name
+ in: query
+ description:
+ required: false
+ type: string
/business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
put:
tags:
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/getDefinitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __METANAME__
put:
tags:
- Business
summary: create or update an existing metadatum
- description: create or update an existing metadatum
+ 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
consumes:
- application/json
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)
required: true
schema:
$ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - Business
+ summary: update an existing metadatum
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- Business
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of resource instance.
required: true
type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/business/connectors/connector/{resource-instance-id}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/connector"
+ $ref: "#/getDefinitions/connector"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of resource instance.
required: true
type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __RESOURCE-INSTANCE-ID__
put:
tags:
- Business
summary: create or update an existing connector
- description: create or update an existing connector
+ 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
consumes:
- application/json
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: body
in: body
- description: connector object that needs to be created or updated
+ description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
required: true
schema:
$ref: "#/definitions/connector"
+ patch:
+ tags:
+ - Business
+ summary: update an existing connector
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: connector object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/connector"
delete:
tags:
- Business
description: Unique id of resource instance.
required: true
type: string
+ example: __RESOURCE-INSTANCE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/connectors"
+ $ref: "#/getDefinitions/connectors"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
put:
tags:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/getDefinitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
- type: string
+ example: __METANAME__
put:
tags:
- Business
summary: create or update an existing metadatum
- description: create or update an existing metadatum
+ 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
consumes:
- application/json
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
required: true
schema:
$ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - Business
+ summary: update an existing metadatum
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- Business
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: service-instance-location-id
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
in: query
- description: An identifier that customers assign to the location where this service is being used.
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-instance"
+ $ref: "#/getDefinitions/service-instance"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
- type: string
+ example: __SERVICE-INSTANCE-ID__
put:
tags:
- Business
summary: create or update an existing service-instance
- description: create or update an existing service-instance
+ 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
consumes:
- application/json
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: body
in: body
- description: service-instance object that needs to be created or updated
+ description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
required: true
schema:
$ref: "#/definitions/service-instance"
+ patch:
+ tags:
+ - Business
+ summary: update an existing service-instance
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: service-instance object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-instance"
delete:
tags:
- Business
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: service-instance-id
in: path
description: Uniquely identifies this instance of a service
required: true
type: string
+ example: __SERVICE-INSTANCE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-instances"
+ $ref: "#/getDefinitions/service-instances"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- - name: subscriber-name
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
in: query
- description: Subscriber name, an alternate way to retrieve a customer.
+ description:
required: false
type: string
- - name: subscriber-type
+ - name: service-instance-name
in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description:
+ required: false
+ type: string
+ - name: persona-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-subscription"
+ $ref: "#/getDefinitions/service-subscription"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
+ example: __SERVICE-TYPE__
put:
tags:
- Business
summary: create or update an existing service-subscription
- description: create or update an existing service-subscription
+ 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
consumes:
- application/json
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: body
in: body
- description: service-subscription object that needs to be created or updated
+ description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
required: true
schema:
$ref: "#/definitions/service-subscription"
+ patch:
+ tags:
+ - Business
+ summary: update an existing service-subscription
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: body
+ in: body
+ description: service-subscription object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-subscription"
delete:
tags:
- Business
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: service-type
in: path
description: Value defined by orchestration to identify this service across ECOMP.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-subscriptions"
+ $ref: "#/getDefinitions/service-subscriptions"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/relationship-list/relationship:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
/business/customers/customer/{global-customer-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/customer"
+ $ref: "#/getDefinitions/customer"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
- type: string
+ example: __GLOBAL-CUSTOMER-ID__
put:
tags:
- Business
summary: create or update an existing customer
- description: create or update an existing customer
+ 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
consumes:
- application/json
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: body
in: body
- description: customer object that needs to be created or updated
+ description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
required: true
schema:
$ref: "#/definitions/customer"
+ patch:
+ tags:
+ - Business
+ summary: update an existing customer
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: body
+ in: body
+ description: customer object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/customer"
delete:
tags:
- Business
description: Global customer id used across ECOMP to uniquely identify customer.
required: true
type: string
+ example: __GLOBAL-CUSTOMER-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/customers"
+ $ref: "#/getDefinitions/customers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: subscriber-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
put:
tags:
description: Unique ID of this asset
required: true
type: string
+ example: __VNF-IMAGE-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique ID of this asset
required: true
type: string
+ example: __VNF-IMAGE-UUID__
/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-image"
+ $ref: "#/getDefinitions/vnf-image"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique ID of this asset
required: true
type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
+ example: __VNF-IMAGE-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing vnf-image
- description: create or update an existing vnf-image
+ 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
consumes:
- application/json
description: Unique ID of this asset
required: true
type: string
+ example: __VNF-IMAGE-UUID__
- name: body
in: body
- description: vnf-image object that needs to be created or updated
+ description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
required: true
schema:
$ref: "#/definitions/vnf-image"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing vnf-image
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: body
+ in: body
+ description: vnf-image object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vnf-image"
delete:
tags:
- ServiceDesignAndCreation
description: Unique ID of this asset
required: true
type: string
+ example: __VNF-IMAGE-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-images"
+ $ref: "#/getDefinitions/vnf-images"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
put:
tags:
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-ID__
/service-design-and-creation/services/service/{service-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/service"
+ $ref: "#/getDefinitions/service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: service-description
- in: query
- description: Description of the service
- required: false
- type: string
+ example: __SERVICE-ID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing service
- description: create or update an existing service
+ 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
consumes:
- application/json
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-ID__
- name: body
in: body
- description: service object that needs to be created or updated
+ description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
required: true
schema:
$ref: "#/definitions/service"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing service
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __SERVICE-ID__
+ - name: body
+ in: body
+ description: service object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service"
delete:
tags:
- ServiceDesignAndCreation
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/services"
+ $ref: "#/getDefinitions/services"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-description
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
put:
tags:
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: vnf-type
in: path
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
+ example: __VNF-TYPE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: vnf-type
in: path
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
+ example: __VNF-TYPE__
/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capability"
+ $ref: "#/getDefinitions/service-capability"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: vnf-type
in: path
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
+ example: __VNF-TYPE__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing service-capability
- description: create or update an existing service-capability
+ 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
consumes:
- application/json
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: vnf-type
in: path
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
+ example: __VNF-TYPE__
- name: body
in: body
- description: service-capability object that needs to be created or updated
+ description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
required: true
schema:
$ref: "#/definitions/service-capability"
- delete:
+ patch:
tags:
- ServiceDesignAndCreation
- summary: delete an existing service-capability
- description: delete an existing service-capability
- operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ summary: update an existing service-capability
+ 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
consumes:
- application/json
- application/xml
description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
+ example: __SERVICE-TYPE__
- name: vnf-type
in: path
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /service-design-and-creation/service-capabilities:
- get:
- tags:
- - ServiceDesignAndCreation
- summary: returns service-capabilities
- description: returns service-capabilities
- operationId: getServiceDesignAndCreationServiceCapabilities
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/service-capabilities"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/models/model/{model-name-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: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-name-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
- in: path
- required: true
- type: string
+ example: __VNF-TYPE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: service-capability object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/service-capability"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ summary: delete an existing service-capability
+ description: delete an existing service-capability
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-name-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - 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
type: string
- - name: constrained-element-set-uuid
+ example: __SERVICE-TYPE__
+ - name: vnf-type
in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
required: true
type: string
- - name: element-choice-set-uuid
- in: path
+ example: __VNF-TYPE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/models/model/{model-name-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}:
+ /service-design-and-creation/service-capabilities:
get:
tags:
- ServiceDesignAndCreation
- summary: returns element-choice-set
- description: returns element-choice-set
- operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ summary: returns service-capabilities
+ description: returns service-capabilities
+ operationId: getServiceDesignAndCreationServiceCapabilities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/getDefinitions/service-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-name-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
- in: path
- required: true
- type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
+ - name: service-type
in: query
- description: Invariant unique ID which does not change from version to version
+ description:
required: false
type: string
- - name: model-version
+ - name: vnf-type
in: query
- description: Version
+ description:
required: false
type: string
+ /service-design-and-creation/models/model/{model-name-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: create or update an existing element-choice-set
- description: create or update an existing element-choice-set
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
- name: element-choice-set-uuid
in: path
required: true
type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
- name: body
in: body
- description: element-choice-set object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
required: true
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/relationship"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing element-choice-set
- description: delete an existing element-choice-set
- operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
- name: element-choice-set-uuid
in: path
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /service-design-and-creation/models/model/{model-name-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:
+ example: __ELEMENT-CHOICE-SET-UUID__
+ /service-design-and-creation/models/model/{model-name-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: returns element-choice-sets
- description: returns element-choice-sets
- operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
+ summary: returns element-choice-set
+ description: returns element-choice-set
+ operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-sets"
+ $ref: "#/getDefinitions/element-choice-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
type: string
- /service-design-and-creation/models/model/{model-name-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:
+ example: __ELEMENT-CHOICE-SET-UUID__
put:
tags:
- ServiceDesignAndCreation
- summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ summary: create or update an existing element-choice-set
+ 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: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/element-choice-set"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing element-choice-set
+ 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: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: body
+ in: body
+ description: element-choice-set object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/element-choice-set"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing element-choice-set
+ description: delete an existing element-choice-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-name-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: returns element-choice-sets
+ description: returns element-choice-sets
+ operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/element-choice-sets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: query
+ description:
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-name-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: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
/service-design-and-creation/models/model/{model-name-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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/getDefinitions/constrained-element-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing constrained-element-set
- description: create or update an existing constrained-element-set
+ 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: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
- name: body
in: body
- description: constrained-element-set object that needs to be created or updated
+ description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
required: true
schema:
$ref: "#/definitions/constrained-element-set"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing constrained-element-set
+ 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: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: constrained-element-set object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/constrained-element-set"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: constrained-element-set-uuid
in: path
required: true
type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-sets"
+ $ref: "#/getDefinitions/constrained-element-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
in: query
- description: Version
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraint"
+ $ref: "#/getDefinitions/model-constraint"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
+ example: __MODEL-CONSTRAINT-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing model-constraint
- description: create or update an existing model-constraint
+ 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: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
consumes:
- application/json
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: body
in: body
- description: model-constraint object that needs to be created or updated
+ description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)
required: true
schema:
$ref: "#/definitions/model-constraint"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-constraint
+ 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: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: model-constraint object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-constraint"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-constraint-uuid
in: path
required: true
type: string
+ example: __MODEL-CONSTRAINT-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraints"
+ $ref: "#/getDefinitions/model-constraints"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
in: query
- description: Version
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
/service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-element"
+ $ref: "#/getDefinitions/model-element"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
+ example: __MODEL-ELEMENT-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing model-element
- description: create or update an existing model-element
+ 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: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElement
consumes:
- application/json
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: body
in: body
- description: model-element object that needs to be created or updated
+ description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
required: true
schema:
$ref: "#/definitions/model-element"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-element
+ 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: UpdateServiceDesignAndCreationModelsModelModelElementsModelElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: model-element object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-element"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-elements"
+ $ref: "#/getDefinitions/model-elements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
+ example: __MODEL-NAME-VERSION-ID__
+ - name: model-element-uuid
in: query
- description: Version
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/getDefinitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: metaname
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
+ example: __METANAME__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing metadatum
- description: create or update an existing metadatum
+ 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: createOrUpdateServiceDesignAndCreationModelsModelMetadataMetadatum
consumes:
- application/json
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)
required: true
schema:
$ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing metadatum
+ 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: UpdateServiceDesignAndCreationModelsModelMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
+ example: __MODEL-NAME-VERSION-ID__
+ - name: metaname
in: query
- description: Version
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
/service-design-and-creation/models/model/{model-name-version-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/model"
+ $ref: "#/getDefinitions/model"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-id
- in: query
- description: Invariant unique ID which does not change from version to version
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
+ example: __MODEL-NAME-VERSION-ID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing model
- description: create or update an existing model
+ 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
consumes:
- application/json
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: body
in: body
- description: model object that needs to be created or updated
+ description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
required: true
schema:
$ref: "#/definitions/model"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-NAME-VERSION-ID__
+ - name: body
+ in: body
+ description: model object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-NAME-VERSION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/models"
+ $ref: "#/getDefinitions/models"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-name-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description:
+ required: false
+ type: string
/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:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: related-lookup-uuid
in: path
required: true
type: string
+ example: __RELATED-LOOKUP-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: related-lookup-uuid
in: path
required: true
type: string
+ example: __RELATED-LOOKUP-UUID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/related-lookup"
+ $ref: "#/getDefinitions/related-lookup"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: related-lookup-uuid
in: path
required: true
type: string
- - name: named-query-name
- in: query
- required: false
- type: string
+ example: __RELATED-LOOKUP-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing related-lookup
- description: create or update an existing related-lookup
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: related-lookup-uuid
in: path
required: true
type: string
+ example: __RELATED-LOOKUP-UUID__
- name: body
in: body
- description: related-lookup object that needs to be created or updated
+ description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
required: true
schema:
$ref: "#/definitions/related-lookup"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing related-lookup
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: body
+ in: body
+ description: related-lookup object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/related-lookup"
delete:
tags:
- ServiceDesignAndCreation
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: related-lookup-uuid
in: path
required: true
type: string
+ example: __RELATED-LOOKUP-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/related-lookups"
+ $ref: "#/getDefinitions/related-lookups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
- - name: named-query-name
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
in: query
+ description:
required: false
type: string
/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}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/property-constraint"
+ $ref: "#/getDefinitions/property-constraint"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: property-constraint-uuid
in: path
required: true
type: string
- - name: named-query-name
- in: query
- required: false
- type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing property-constraint
- description: create or update an existing property-constraint
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: property-constraint-uuid
in: path
required: true
type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
- name: body
in: body
- description: property-constraint object that needs to be created or updated
+ description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
required: true
schema:
$ref: "#/definitions/property-constraint"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing property-constraint
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: property-constraint object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/property-constraint"
delete:
tags:
- ServiceDesignAndCreation
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: property-constraint-uuid
in: path
required: true
type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/property-constraints"
+ $ref: "#/getDefinitions/property-constraints"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
- - name: named-query-name
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
in: query
+ description:
required: false
type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query-element"
+ $ref: "#/getDefinitions/named-query-element"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
- - name: named-query-name
- in: query
- required: false
- type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing named-query-element
- description: create or update an existing named-query-element
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: body
in: body
- description: named-query-element object that needs to be created or updated
+ description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
required: true
schema:
$ref: "#/definitions/named-query-element"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing named-query-element
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: named-query-element object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/named-query-element"
delete:
tags:
- ServiceDesignAndCreation
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: named-query-element-uuid
in: path
required: true
type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query-elements"
+ $ref: "#/getDefinitions/named-query-elements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: named-query-name
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
in: query
+ description:
required: false
type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
/service-design-and-creation/named-queries/named-query/{named-query-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-query"
+ $ref: "#/getDefinitions/named-query"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: named-query-name
- in: query
- required: false
- type: string
+ example: __NAMED-QUERY-UUID__
put:
tags:
- ServiceDesignAndCreation
summary: create or update an existing named-query
- description: create or update an existing named-query
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: body
in: body
- description: named-query object that needs to be created or updated
+ description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
required: true
schema:
$ref: "#/definitions/named-query"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing named-query
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: body
+ in: body
+ description: named-query object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/named-query"
delete:
tags:
- ServiceDesignAndCreation
in: path
required: true
type: string
+ example: __NAMED-QUERY-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/named-queries"
+ $ref: "#/getDefinitions/named-queries"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: query
+ description:
+ required: false
+ type: string
+ - name: named-query-name
+ in: query
+ description:
+ required: false
+ type: string
/network/logical-links/logical-link/{link-name}/relationship-list/relationship:
put:
tags:
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
+ example: __LINK-NAME__
/network/logical-links/logical-link/{link-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/logical-link"
+ $ref: "#/getDefinitions/logical-link"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: link-id
- in: query
- description: UUID of the logical-link, SDNC generates this.
- required: false
- type: string
+ example: __LINK-NAME__
put:
tags:
- Network
summary: create or update an existing logical-link
- description: create or update an existing logical-link
+ 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
consumes:
- application/json
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: body
in: body
- description: logical-link object that needs to be created or updated
+ description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
required: true
schema:
$ref: "#/definitions/logical-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing logical-link
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: logical-link object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/logical-link"
delete:
tags:
- Network
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/logical-links"
+ $ref: "#/getDefinitions/logical-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: link-id
+ in: query
+ description:
+ required: false
+ type: string
/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:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: cos
in: path
description: unique identifier of probe
required: true
type: string
+ example: __COS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: cos
in: path
description: unique identifier of probe
required: true
type: string
+ example: __COS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/class-of-service"
+ $ref: "#/getDefinitions/class-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: cos
in: path
description: unique identifier of probe
required: true
type: string
+ example: __COS__
put:
tags:
- Network
summary: create or update an existing class-of-service
- description: create or update an existing class-of-service
+ 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
consumes:
- application/json
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: cos
in: path
description: unique identifier of probe
required: true
type: string
+ example: __COS__
- name: body
in: body
- description: class-of-service object that needs to be created or updated
+ description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
required: true
schema:
$ref: "#/definitions/class-of-service"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing class-of-service
- description: delete an existing class-of-service
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ summary: update an existing class-of-service
+ 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
consumes:
- application/json
- application/xml
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: cos
in: path
description: unique identifier of probe
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __COS__
+ - name: body
+ in: body
+ description: class-of-service object that needs to be updated.
required: true
- type: string
- /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:
+ schema:
+ $ref: "#/patchDefinitions/class-of-service"
+ delete:
tags:
- Network
- summary: returns classes-of-service
- description: returns classes-of-service
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
+ summary: delete an existing class-of-service
+ description: delete an existing class-of-service
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/classes-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
- /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:
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns classes-of-service
+ description: returns classes-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/classes-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: query
+ description:
+ required: false
+ type: string
+ /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: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair"
+ $ref: "#/getDefinitions/site-pair"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
put:
tags:
- Network
summary: create or update an existing site-pair
- description: create or update an existing site-pair
+ 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
consumes:
- application/json
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: body
in: body
- description: site-pair object that needs to be created or updated
+ description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
required: true
schema:
$ref: "#/definitions/site-pair"
+ patch:
+ tags:
+ - Network
+ summary: update an existing site-pair
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: body
+ in: body
+ description: site-pair object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/site-pair"
delete:
tags:
- Network
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: site-pair-id
in: path
description: unique identifier of probe
required: true
type: string
+ example: __SITE-PAIR-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pairs"
+ $ref: "#/getDefinitions/site-pairs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: query
+ description:
+ required: false
+ type: string
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
put:
tags:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/routing-instance"
+ $ref: "#/getDefinitions/routing-instance"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
put:
tags:
- Network
summary: create or update an existing routing-instance
- description: create or update an existing routing-instance
+ 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
consumes:
- application/json
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: body
in: body
- description: routing-instance object that needs to be created or updated
+ description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
required: true
schema:
$ref: "#/definitions/routing-instance"
+ patch:
+ tags:
+ - Network
+ summary: update an existing routing-instance
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: body
+ in: body
+ description: routing-instance object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/routing-instance"
delete:
tags:
- Network
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: routing-instance-id
in: path
description: Unique id of routing instance
required: true
type: string
+ example: __ROUTING-INSTANCE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/routing-instances"
+ $ref: "#/getDefinitions/routing-instances"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: query
+ description:
+ required: false
+ type: string
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
put:
tags:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
/network/site-pair-sets/site-pair-set/{site-pair-set-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair-set"
+ $ref: "#/getDefinitions/site-pair-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
put:
tags:
- Network
summary: create or update an existing site-pair-set
- description: create or update an existing site-pair-set
+ 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
consumes:
- application/json
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: body
in: body
- description: site-pair-set object that needs to be created or updated
+ description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
required: true
schema:
$ref: "#/definitions/site-pair-set"
+ patch:
+ tags:
+ - Network
+ summary: update an existing site-pair-set
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: body
+ in: body
+ description: site-pair-set object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/site-pair-set"
delete:
tags:
- Network
description: Unique id of site pair set.
required: true
type: string
+ example: __SITE-PAIR-SET-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/site-pair-sets"
+ $ref: "#/getDefinitions/site-pair-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
put:
tags:
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
/network/vpn-bindings/vpn-binding/{vpn-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpn-binding"
+ $ref: "#/getDefinitions/vpn-binding"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: VPN ID, globally unique within A&AI
required: true
type: string
- - name: vpn-name
- in: query
- description: VPN Name
- required: false
- type: string
- - name: global-route-target
- in: query
- description: Number used to identify a VPN, globally unique in the network
- required: false
- type: string
+ example: __VPN-ID__
put:
tags:
- Network
summary: create or update an existing vpn-binding
- description: create or update an existing vpn-binding
+ 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
consumes:
- application/json
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
- name: body
in: body
- description: vpn-binding object that needs to be created or updated
+ description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
required: true
schema:
$ref: "#/definitions/vpn-binding"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vpn-binding
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: body
+ in: body
+ description: vpn-binding object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vpn-binding"
delete:
tags:
- Network
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpn-bindings"
+ $ref: "#/getDefinitions/vpn-bindings"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vpn-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: global-route-target
+ in: query
+ description:
+ required: false
+ type: string
/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
put:
tags:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
put:
tags:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /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: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: equipment-name
- in: path
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-vlan-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-mac-filter
in: query
- description: MAC address for the interface
+ description:
required: false
type: string
- - name: network-name
+ - name: vf-vlan-strip
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: prov-status
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: macaddr
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interface"
+ $ref: "#/getDefinitions/p-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing p-interface
- description: create or update an existing p-interface
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: p-interface object that needs to be created or updated
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing p-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interfaces"
+ $ref: "#/getDefinitions/p-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: prov-status
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-vlan-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-mac-filter
in: query
- description: MAC address for the interface
+ description:
required: false
type: string
- - name: network-name
+ - name: vf-vlan-strip
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: prov-status
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: macaddr
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/getDefinitions/lag-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: lag-interface object that needs to be created or updated
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $ref: "#/getDefinitions/lag-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: prov-status
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpls-pe"
+ $ref: "#/getDefinitions/vpls-pe"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
+ example: __EQUIPMENT-NAME__
put:
tags:
- Network
summary: create or update an existing vpls-pe
- description: create or update an existing vpls-pe
+ 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
consumes:
- application/json
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: body
in: body
- description: vpls-pe object that needs to be created or updated
+ description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
required: true
schema:
$ref: "#/definitions/vpls-pe"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vpls-pe
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: body
+ in: body
+ description: vpls-pe object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vpls-pe"
delete:
tags:
- Network
in: path
required: true
type: string
+ example: __EQUIPMENT-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vpls-pes"
+ $ref: "#/getDefinitions/vpls-pes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
put:
tags:
description: Unique id of multicast configuration.
required: true
type: string
+ example: __MULTICAST-CONFIGURATION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of multicast configuration.
required: true
type: string
+ example: __MULTICAST-CONFIGURATION-ID__
/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/multicast-configuration"
+ $ref: "#/getDefinitions/multicast-configuration"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of multicast configuration.
required: true
type: string
+ example: __MULTICAST-CONFIGURATION-ID__
put:
tags:
- Network
summary: create or update an existing multicast-configuration
- description: create or update an existing multicast-configuration
+ 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
consumes:
- application/json
description: Unique id of multicast configuration.
required: true
type: string
+ example: __MULTICAST-CONFIGURATION-ID__
- name: body
in: body
- description: multicast-configuration object that needs to be created or updated
+ description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
required: true
schema:
$ref: "#/definitions/multicast-configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing multicast-configuration
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: multicast-configuration object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/multicast-configuration"
delete:
tags:
- Network
description: Unique id of multicast configuration.
required: true
type: string
+ example: __MULTICAST-CONFIGURATION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/multicast-configurations"
+ $ref: "#/getDefinitions/multicast-configurations"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
put:
tags:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: cvlan-tag
in: path
description: See mis-na-virtualization-platform.yang
required: true
type: integer
format: int64
+ example: __CVLAN-TAG__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: cvlan-tag
in: path
description: See mis-na-virtualization-platform.yang
required: true
type: integer
format: int64
+ example: __CVLAN-TAG__
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/cvlan-tag-entry"
+ $ref: "#/getDefinitions/cvlan-tag-entry"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: cvlan-tag
in: path
description: See mis-na-virtualization-platform.yang
required: true
type: integer
format: int64
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
+ example: __CVLAN-TAG__
put:
tags:
- Network
summary: create or update an existing cvlan-tag-entry
- description: create or update an existing cvlan-tag-entry
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: cvlan-tag
in: path
description: See mis-na-virtualization-platform.yang
required: true
type: integer
format: int64
+ example: __CVLAN-TAG__
- name: body
in: body
- description: cvlan-tag-entry object that needs to be created or updated
+ description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
required: true
schema:
$ref: "#/definitions/cvlan-tag-entry"
+ patch:
+ tags:
+ - Network
+ summary: update an existing cvlan-tag-entry
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: body
+ in: body
+ description: cvlan-tag-entry object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/cvlan-tag-entry"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: cvlan-tag
in: path
description: See mis-na-virtualization-platform.yang
required: true
type: integer
format: int64
+ example: __CVLAN-TAG__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/cvlan-tags"
+ $ref: "#/getDefinitions/cvlan-tags"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
+ type: integer
+ format: int64
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
+ example: __INTERFACE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
+ example: __INTERFACE-ID__
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
+ get:
+ tags:
+ - Network
+ summary: returns port-group
+ description: returns port-group
+ operationId: getNetworkVcesVcePortGroupsPortGroup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/port-group"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
+ example: __INTERFACE-ID__
put:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ summary: create or update an existing port-group
+ 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
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
required: true
schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
- get:
- tags:
- - Network
- summary: returns port-group
- description: returns port-group
- operationId: getNetworkVcesVcePortGroupsPortGroup
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/port-group"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: interface-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- put:
+ $ref: "#/definitions/port-group"
+ patch:
tags:
- Network
- summary: create or update an existing port-group
- description: create or update an existing port-group
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
+ summary: update an existing port-group
+ 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
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: body
in: body
- description: port-group object that needs to be created or updated
+ description: port-group object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/port-group"
+ $ref: "#/patchDefinitions/port-group"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-id
in: path
description: Unique ID of the interface
required: true
type: string
+ example: __INTERFACE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/port-groups"
+ $ref: "#/getDefinitions/port-groups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
+ example: __VNF-ID__
+ - name: interface-id
in: query
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
+ description:
required: false
type: string
- - name: regional-resource-zone
+ - name: port-group-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: switch-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- name: heat-stack-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
+ description:
required: false
type: string
/network/vces/vce/{vnf-id}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
/network/vces/vce/{vnf-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vce"
+ $ref: "#/getDefinitions/vce"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
+ example: __VNF-ID__
put:
tags:
- Network
summary: create or update an existing vce
- description: create or update an existing vce
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: body
in: body
- description: vce object that needs to be created or updated
+ description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
required: true
schema:
$ref: "#/definitions/vce"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vce
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: vce object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vce"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vces"
+ $ref: "#/getDefinitions/vces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
put:
tags:
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
/network/vnfcs/vnfc/{vnfc-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnfc"
+ $ref: "#/getDefinitions/vnfc"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique ID of vnfc.
required: true
type: string
- - name: vnfc-function-code
- in: query
- description: function code
- required: false
- type: string
- - name: vnfc-type
- in: query
- description: type
- required: false
- type: string
- - name: prov-status
- in: query
- description: prov status of this vnfc
- required: false
- type: string
- - name: ipaddress-v4-oam-vip
- in: query
- description: Oam V4 vip address of this vnfc
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: group-notation
- in: query
- description: Group notation of VNFC
- required: false
- type: string
+ example: __VNFC-NAME__
put:
tags:
- Network
summary: create or update an existing vnfc
- description: create or update an existing vnfc
+ 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
consumes:
- application/json
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: body
in: body
- description: vnfc object that needs to be created or updated
+ description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
required: true
schema:
$ref: "#/definitions/vnfc"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vnfc
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: body
+ in: body
+ description: vnfc object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vnfc"
delete:
tags:
- Network
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnfcs"
+ $ref: "#/getDefinitions/vnfcs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnfc-function-code
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnfc-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description:
+ required: false
+ type: string
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
put:
tags:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: subnet-id
in: path
description: Subnet ID, should be UUID.
required: true
type: string
+ example: __SUBNET-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: subnet-id
in: path
description: Subnet ID, should be UUID.
required: true
type: string
+ example: __SUBNET-ID__
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/subnet"
+ $ref: "#/getDefinitions/subnet"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: subnet-id
in: path
description: Subnet ID, should be UUID.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: subnet-name
- in: query
- description: Name associated with the subnet.
- required: false
- type: string
+ example: __SUBNET-ID__
put:
tags:
- Network
summary: create or update an existing subnet
- description: create or update an existing subnet
+ 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
consumes:
- application/json
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: subnet-id
in: path
description: Subnet ID, should be UUID.
required: true
type: string
+ example: __SUBNET-ID__
- name: body
in: body
- description: subnet object that needs to be created or updated
+ description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
required: true
schema:
$ref: "#/definitions/subnet"
+ patch:
+ tags:
+ - Network
+ summary: update an existing subnet
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: body
+ in: body
+ description: subnet object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/subnet"
delete:
tags:
- Network
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: subnet-id
in: path
description: Subnet ID, should be UUID.
required: true
type: string
+ example: __SUBNET-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/subnets"
+ $ref: "#/getDefinitions/subnets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
+ example: __NETWORK-ID__
+ - name: subnet-id
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- - name: widget-model-version
+ - name: subnet-name
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: vlan-id-inner
in: path
description: id.
required: true
type: integer
format: int64
+ example: __VLAN-ID-INNER__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: vlan-id-inner
in: path
description: id.
required: true
type: integer
format: int64
+ example: __VLAN-ID-INNER__
/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/ctag-assignment"
+ $ref: "#/getDefinitions/ctag-assignment"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: vlan-id-inner
in: path
description: id.
required: true
type: integer
format: int64
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __VLAN-ID-INNER__
put:
tags:
- Network
summary: create or update an existing ctag-assignment
- description: create or update an existing ctag-assignment
+ 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
consumes:
- application/json
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: vlan-id-inner
in: path
description: id.
required: true
type: integer
format: int64
+ example: __VLAN-ID-INNER__
- name: body
in: body
- description: ctag-assignment object that needs to be created or updated
+ description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
required: true
schema:
$ref: "#/definitions/ctag-assignment"
+ patch:
+ tags:
+ - Network
+ summary: update an existing ctag-assignment
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: body
+ in: body
+ description: ctag-assignment object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ctag-assignment"
delete:
tags:
- Network
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: vlan-id-inner
in: path
description: id.
required: true
type: integer
format: int64
+ example: __VLAN-ID-INNER__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/ctag-assignments"
+ $ref: "#/getDefinitions/ctag-assignments"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
- type: string
+ type: integer
+ format: int64
/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
put:
tags:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: segmentation-id
in: path
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __SEGMENTATION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: segmentation-id
in: path
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __SEGMENTATION-ID__
/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/segmentation-assignment"
+ $ref: "#/getDefinitions/segmentation-assignment"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: segmentation-id
in: path
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __SEGMENTATION-ID__
put:
tags:
- Network
summary: create or update an existing segmentation-assignment
- description: create or update an existing segmentation-assignment
+ 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
consumes:
- application/json
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: segmentation-id
in: path
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __SEGMENTATION-ID__
- name: body
in: body
- description: segmentation-assignment object that needs to be created or updated
+ description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
required: true
schema:
$ref: "#/definitions/segmentation-assignment"
+ patch:
+ tags:
+ - Network
+ summary: update an existing segmentation-assignment
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: body
+ in: body
+ description: segmentation-assignment object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/segmentation-assignment"
delete:
tags:
- Network
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: segmentation-id
in: path
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __SEGMENTATION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/segmentation-assignments"
+ $ref: "#/getDefinitions/segmentation-assignments"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
+ example: __NETWORK-ID__
+ - name: segmentation-id
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
/network/l3-networks/l3-network/{network-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-network"
+ $ref: "#/getDefinitions/l3-network"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __NETWORK-ID__
put:
tags:
- Network
summary: create or update an existing l3-network
- description: create or update an existing l3-network
+ 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
consumes:
- application/json
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: body
in: body
- description: l3-network object that needs to be created or updated
+ description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
required: true
schema:
$ref: "#/definitions/l3-network"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-network
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: body
+ in: body
+ description: l3-network object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-network"
delete:
tags:
- Network
description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
+ example: __NETWORK-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-networks"
+ $ref: "#/getDefinitions/l3-networks"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
put:
tags:
description: UUID representing unique key to this instance
required: true
type: string
+ example: __NETWORK-POLICY-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: UUID representing unique key to this instance
required: true
type: string
+ example: __NETWORK-POLICY-ID__
/network/network-policies/network-policy/{network-policy-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-policy"
+ $ref: "#/getDefinitions/network-policy"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: UUID representing unique key to this instance
required: true
type: string
- - name: network-policy-fqdn
- in: query
- description: Contrail FQDN for the policy
- required: false
- type: string
+ example: __NETWORK-POLICY-ID__
put:
tags:
- Network
summary: create or update an existing network-policy
- description: create or update an existing network-policy
+ 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
consumes:
- application/json
description: UUID representing unique key to this instance
required: true
type: string
+ example: __NETWORK-POLICY-ID__
- name: body
in: body
- description: network-policy object that needs to be created or updated
+ description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
required: true
schema:
$ref: "#/definitions/network-policy"
+ patch:
+ tags:
+ - Network
+ summary: update an existing network-policy
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: body
+ in: body
+ description: network-policy object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/network-policy"
delete:
tags:
- Network
description: UUID representing unique key to this instance
required: true
type: string
+ example: __NETWORK-POLICY-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/network-policies"
+ $ref: "#/getDefinitions/network-policies"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-policy-fqdn
+ in: query
+ description:
+ required: false
+ type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
put:
tags:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
put:
tags:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-mac-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
+ - name: vf-vlan-strip
in: query
+ description:
required: false
type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
+ example: __VNF-ID__
+ - name: interface-name
in: query
- description: the ASDC model id for this resource or service model.
+ description:
required: false
type: string
- - name: persona-model-version
+ - name: interface-id
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
- - name: widget-model-id
+ - name: macaddr
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- - name: widget-model-version
+ - name: network-name
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: update an existing sriov-vf
+ 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
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-mac-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
+ - name: vf-vlan-strip
in: query
+ description:
required: false
type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
+ example: __INTERFACE-NAME__
+ - name: interface-name
in: query
- description: the ASDC model id for this resource or service model.
+ description:
required: false
type: string
- - name: persona-model-version
+ - name: interface-id
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
- - name: widget-model-id
+ - name: macaddr
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- - name: widget-model-version
+ - name: network-name
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/getDefinitions/lag-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: lag-interface object that needs to be created or updated
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $ref: "#/getDefinitions/lag-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
+ example: __VNF-ID__
+ - name: interface-name
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: vf-module-id
in: path
description: Unique ID of vf-module.
required: true
type: string
+ example: __VF-MODULE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: vf-module-id
in: path
description: Unique ID of vf-module.
required: true
type: string
+ example: __VF-MODULE-ID__
/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vf-module"
+ $ref: "#/getDefinitions/vf-module"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: vf-module-id
in: path
description: Unique ID of vf-module.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: vf-module-name
- in: query
- description: Name of vf-module
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance.
- required: false
- type: string
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
- - name: contrail-service-instance-fqdn
- in: query
- description: the Contrail unique ID for a service-instance
- required: false
- type: string
+ example: __VF-MODULE-ID__
put:
tags:
- Network
summary: create or update an existing vf-module
- description: create or update an existing vf-module
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: vf-module-id
in: path
description: Unique ID of vf-module.
required: true
type: string
+ example: __VF-MODULE-ID__
- name: body
in: body
- description: vf-module object that needs to be created or updated
+ description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
required: true
schema:
$ref: "#/definitions/vf-module"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vf-module
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: body
+ in: body
+ description: vf-module object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vf-module"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: vf-module-id
in: path
description: Unique ID of vf-module.
required: true
type: string
+ example: __VF-MODULE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vf-modules"
+ $ref: "#/getDefinitions/vf-modules"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
+ example: __VNF-ID__
+ - name: vf-module-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-module-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- name: heat-stack-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- name: persona-model-id
in: query
- description: the ASDC model id for this resource or service model.
+ description:
required: false
type: string
- name: persona-model-version
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
- name: widget-model-id
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- name: widget-model-version
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
+ required: false
+ type: string
+ - name: contrail-service-instance-fqdn
+ in: query
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/generic-vnf"
+ $ref: "#/getDefinitions/generic-vnf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: persona-model-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: persona-model-version
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
+ example: __VNF-ID__
put:
tags:
- Network
summary: create or update an existing generic-vnf
- description: create or update an existing generic-vnf
+ 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
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: body
in: body
- description: generic-vnf object that needs to be created or updated
+ description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
required: true
schema:
$ref: "#/definitions/generic-vnf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing generic-vnf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: generic-vnf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/generic-vnf"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/generic-vnfs"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
+ $ref: "#/getDefinitions/generic-vnfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: link-name
- in: path
- description: Alphabetical concatenation of lag-interface names
- required: true
+ - name: vnf-id
+ in: query
+ description:
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: persona-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: persona-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
description: Alphabetical concatenation of lag-interface names
required: true
type: string
+ example: __LINK-NAME__
/network/lag-links/lag-link/{link-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-link"
+ $ref: "#/getDefinitions/lag-link"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Alphabetical concatenation of lag-interface names
required: true
type: string
+ example: __LINK-NAME__
put:
tags:
- Network
summary: create or update an existing lag-link
- description: create or update an existing lag-link
+ 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
consumes:
- application/json
description: Alphabetical concatenation of lag-interface names
required: true
type: string
+ example: __LINK-NAME__
- name: body
in: body
- description: lag-link object that needs to be created or updated
+ description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
required: true
schema:
$ref: "#/definitions/lag-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-link
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: lag-link object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-link"
delete:
tags:
- Network
description: Alphabetical concatenation of lag-interface names
required: true
type: string
+ example: __LINK-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-links"
+ $ref: "#/getDefinitions/lag-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: query
+ description:
+ required: false
+ type: string
/network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
put:
tags:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
put:
tags:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-vlan-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
+ example: __VNF-ID2__
+ - name: interface-name
in: query
- description: Alternate name of VNF.
+ description:
required: false
type: string
- - name: vnf-type
+ - name: interface-id
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ description:
required: false
type: string
- - name: prov-status
+ - name: macaddr
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: network-name
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/newvce"
+ $ref: "#/getDefinitions/newvce"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
+ example: __VNF-ID2__
put:
tags:
- Network
summary: create or update an existing newvce
- description: create or update an existing newvce
+ 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
consumes:
- application/json
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: body
in: body
- description: newvce object that needs to be created or updated
+ description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
required: true
schema:
$ref: "#/definitions/newvce"
+ patch:
+ tags:
+ - Network
+ summary: update an existing newvce
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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
+ type: string
+ example: __VNF-ID2__
+ - name: body
+ in: body
+ description: newvce object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/newvce"
delete:
tags:
- Network
description: Unique id of VNF, can't use same attribute name right now until we promote this new object
required: true
type: string
+ example: __VNF-ID2__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/newvces"
+ $ref: "#/getDefinitions/newvces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
/network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
put:
tags:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
put:
tags:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /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: see node definition for valid relationships
- operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: pnf-name
- in: path
- description: unique name of Physical Network Function.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- /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: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: pnf-name
- in: path
- description: unique name of Physical Network Function.
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv6-address
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
+ /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: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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: returns vlan
- description: returns vlan
- operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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: returns vlan
+ description: returns vlan
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-vlan-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-mac-filter
in: query
- description: MAC address for the interface
+ description:
required: false
type: string
- - name: network-name
+ - name: vf-vlan-strip
in: query
- description: Name of the network
+ description:
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: orchestration-status
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-id
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interface"
+ $ref: "#/getDefinitions/p-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing p-interface
- description: create or update an existing p-interface
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: p-interface object that needs to be created or updated
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
required: true
schema:
$ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing p-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interfaces"
+ $ref: "#/getDefinitions/p-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
- - name: orchestration-status
+ example: __PNF-NAME__
+ - name: interface-name
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/getDefinitions/vlan"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: vpn-id
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
+ example: __VLAN-INTERFACE__
put:
tags:
- Network
summary: create or update an existing vlan
- description: create or update an existing vlan
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: vlan-interface
in: path
description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $ref: "#/getDefinitions/vlans"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/getDefinitions/sriov-vf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
- type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
- type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
- type: string
+ example: __PCI-ID__
put:
tags:
- Network
summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: pci-id
in: path
description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $ref: "#/getDefinitions/sriov-vfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-vlan-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-mac-filter
in: query
- description: MAC address for the interface
+ description:
required: false
type: string
- - name: network-name
+ - name: vf-vlan-strip
in: query
- description: Name of the network
+ description:
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
/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:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: update an existing l3-interface-ipv4-address-list
+ 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
consumes:
- application/json
- application/xml
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/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:
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
put:
tags:
- Network
summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing l-interface
- description: create or update an existing l-interface
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: l-interface object that needs to be created or updated
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
$ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: interface-name
in: path
description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: orchestration-status
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: macaddr
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/getDefinitions/lag-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
+ example: __INTERFACE-NAME__
put:
tags:
- Network
summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: lag-interface object that needs to be created or updated
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: interface-name
in: path
description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $ref: "#/getDefinitions/lag-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
- - name: orchestration-status
+ example: __PNF-NAME__
+ - name: interface-name
in: query
- description: orchestration-status is the status of orchestration on the PNF.
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}:
"200":
description: successful operation
schema:
- $ref: "#/definitions/pnf"
+ $ref: "#/getDefinitions/pnf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: unique name of Physical Network Function.
required: true
type: string
- - name: orchestration-status
- in: query
- description: orchestration-status is the status of orchestration on the PNF.
- required: false
- type: string
+ example: __PNF-NAME__
put:
tags:
- Network
summary: create or update an existing pnf
- description: create or update an existing pnf
+ 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
consumes:
- application/json
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: body
in: body
- description: pnf object that needs to be created or updated
+ description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
required: true
schema:
$ref: "#/definitions/pnf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing pnf
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: body
+ in: body
+ description: pnf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/pnf"
delete:
tags:
- Network
description: unique name of Physical Network Function.
required: true
type: string
+ example: __PNF-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/pnfs"
+ $ref: "#/getDefinitions/pnfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description:
+ required: false
+ type: string
/network/physical-links/physical-link/{link-name}/relationship-list/relationship:
put:
tags:
description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
required: true
type: string
+ example: __LINK-NAME__
/network/physical-links/physical-link/{link-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/physical-link"
+ $ref: "#/getDefinitions/physical-link"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
required: true
type: string
- - name: circuit-id
- in: query
- description: Circuit it
- required: false
- type: string
+ example: __LINK-NAME__
put:
tags:
- Network
summary: create or update an existing physical-link
- description: create or update an existing physical-link
+ 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
consumes:
- application/json
description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: body
in: body
- description: physical-link object that needs to be created or updated
+ description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
required: true
schema:
$ref: "#/definitions/physical-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing physical-link
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: physical-link object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/physical-link"
delete:
tags:
- Network
description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
required: true
type: string
+ example: __LINK-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/physical-links"
+ $ref: "#/getDefinitions/physical-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: circuit-id
+ in: query
+ description:
+ required: false
+ type: string
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
put:
tags:
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
put:
tags:
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: vig-address-type
in: path
description: indicates whether the VIG is for AVPN or INTERNET
required: true
type: string
+ example: __VIG-ADDRESS-TYPE__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: vig-address-type
in: path
description: indicates whether the VIG is for AVPN or INTERNET
required: true
type: string
+ example: __VIG-ADDRESS-TYPE__
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/vig-server"
+ $ref: "#/getDefinitions/vig-server"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: vig-address-type
in: path
description: indicates whether the VIG is for AVPN or INTERNET
required: true
type: string
+ example: __VIG-ADDRESS-TYPE__
put:
tags:
- Network
summary: create or update an existing vig-server
- description: create or update an existing vig-server
+ 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
consumes:
- application/json
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: vig-address-type
in: path
description: indicates whether the VIG is for AVPN or INTERNET
required: true
type: string
+ example: __VIG-ADDRESS-TYPE__
- name: body
in: body
- description: vig-server object that needs to be created or updated
+ description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
required: true
schema:
$ref: "#/definitions/vig-server"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vig-server
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ - name: body
+ in: body
+ description: vig-server object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vig-server"
delete:
tags:
- Network
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: vig-address-type
in: path
description: indicates whether the VIG is for AVPN or INTERNET
required: true
type: string
+ example: __VIG-ADDRESS-TYPE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/vig-servers"
+ $ref: "#/getDefinitions/vig-servers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: query
+ description:
+ required: false
+ type: string
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/ipsec-configuration"
+ $ref: "#/getDefinitions/ipsec-configuration"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
put:
tags:
- Network
summary: create or update an existing ipsec-configuration
- description: create or update an existing ipsec-configuration
+ 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
consumes:
- application/json
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: body
in: body
- description: ipsec-configuration object that needs to be created or updated
+ description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
required: true
schema:
$ref: "#/definitions/ipsec-configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing ipsec-configuration
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: ipsec-configuration object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ipsec-configuration"
delete:
tags:
- Network
description: UUID of this configuration
required: true
type: string
+ example: __IPSEC-CONFIGURATION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/ipsec-configurations"
+ $ref: "#/getDefinitions/ipsec-configurations"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: query
+ description:
+ required: false
+ type: string
/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
put:
tags:
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
/network/route-table-references/route-table-reference/{route-table-reference-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-table-reference"
+ $ref: "#/getDefinitions/route-table-reference"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
- - name: route-table-reference-fqdn
- in: query
- description: FQDN entry in the route table.
- required: false
- type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
put:
tags:
- Network
summary: create or update an existing route-table-reference
- description: create or update an existing route-table-reference
+ 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
consumes:
- application/json
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
- name: body
in: body
- description: route-table-reference object that needs to be created or updated
+ description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
required: true
schema:
$ref: "#/definitions/route-table-reference"
+ patch:
+ tags:
+ - Network
+ summary: update an existing route-table-reference
+ 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
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: body
+ in: body
+ description: route-table-reference object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/route-table-reference"
delete:
tags:
- Network
description: Route Table Reference id, UUID assigned to this instance.
required: true
type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-table-references"
+ $ref: "#/getDefinitions/route-table-references"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: route-table-reference-fqdn
+ in: query
+ description:
+ required: false
+ type: string
definitions:
- search:
+ action:
properties:
- edge-tag-query-result:
- type: object
- $ref: "#/definitions/edge-tag-query-result"
- edge-tag-query-request:
- type: object
- $ref: "#/definitions/edge-tag-query-request"
- search-results:
- type: object
- $ref: "#/definitions/search-results"
- sdn-zone-response:
- type: object
- $ref: "#/definitions/sdn-zone-response"
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/definitions/action-data"
+ action-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
actions:
description: |
APIs that are more action related than REST (e.g., notify, update).
notify:
type: object
$ref: "#/definitions/notify"
- relationship-data:
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
required:
- - relationship-key
- - relationship-value
+ - id
properties:
- relationship-key:
+ id:
type: string
- description: A keyword provided by A&AI to indicate an attribute.
- relationship-value:
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
type: string
- description: Value of the attribute.
- related-to-property:
- properties:
- property-key:
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
type: string
- description: Key part of a key/value pair
- property-value:
+ description: Link back to more information in the controller
+ persona-model-id:
type: string
- description: Value part of a key/value pair
- relationship:
- properties:
- related-to:
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
type: string
- description: A keyword provided by A&AI to indicate type of node.
- related-link:
+ description: the ASDC model version for this resource or service model.
+ model-version-id:
type: string
- description: URL to the object in A&AI.
- relationship-data:
+ description: the ASDC model version for this resource or service model.
+ persona-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: Concurrency value
+ tunnel-xconnects:
type: array
- items:
- $ref: "#/definitions/relationship-data"
- related-to-property:
+ items:
+ $ref: "#/definitions/tunnel-xconnect"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
type: array
items:
- $ref: "#/definitions/related-to-property"
- relationship-list:
+ $ref: "#/definitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - 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
+
+ required:
+ - availability-zone-name
+ - hypervisor-type
properties:
- relationship:
+ 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-state:
+ 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: "#/definitions/relationship"
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
type: array
items:
+ $ref: "#/definitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
+ type: object
+ $ref: "#/definitions/dvs-switches"
+ availability-zone:
+ type: object
+ $ref: "#/definitions/availability-zone"
+ business:
+ description: |
+ Namespace for business related constructs
+ properties:
+ connectors:
+ type: array
+ items:
+ $ref: "#/definitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/definitions/customer"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
+ required:
+ - cos
+ 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: "#/definitions/relationship"
- ctag-pool:
+ classes-of-service:
description: |
- A collection of C tags (vlan tags) grouped for a specific purpose.
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/definitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/definitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/definitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/definitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/definitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/definitions/virtual-data-center"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
- - TO availability-zone (Many2Many)
- - FROM complex (is composed of ctag-pool)
- - FROM vpls-pe
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver LocatedIn 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,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
+
required:
- - target-pe
- - availability-zone-name
- - ctag-pool-purpose
+ - cloud-owner
+ - cloud-region-id
properties:
- target-pe:
+ cloud-owner:
type: string
- description: The Target provider edge router
- availability-zone-name:
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
type: string
- description: Name of the availability zone
- ctag-pool-purpose:
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
type: string
- description: Describes what the intended purpose of this pool is.
- ctag-values:
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
type: string
- description: Comma separated list of ctags
+ description: Cloud-owner defined type indicator (e.g., DCP, LCP)
+ cloud-region-version:
+ type: string
+ description: Software version employed at the site
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance
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: "#/definitions/volume-group"
+ tenants:
+ type: array
+ items:
+ $ref: "#/definitions/tenant"
+ flavors:
+ type: array
+ items:
+ $ref: "#/definitions/flavor"
+ group-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/group-assignment"
+ snapshots:
+ type: array
+ items:
+ $ref: "#/definitions/snapshot"
+ images:
+ type: array
+ items:
+ $ref: "#/definitions/image"
+ dvs-switches:
+ type: array
+ items:
+ $ref: "#/definitions/dvs-switch"
+ oam-networks:
+ type: array
+ items:
+ $ref: "#/definitions/oam-network"
+ availability-zones:
+ type: array
+ items:
+ $ref: "#/definitions/availability-zone"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- ctag-pools:
+ cloud-regions:
properties:
- ctag-pool:
+ cloud-region:
type: array
items:
- $ref: "#/definitions/ctag-pool"
+ $ref: "#/definitions/cloud-region"
complex:
description: |
Collection of physical locations that can house cloud-regions.
###### Related Nodes
- - TO ctag-pool (comprises complex, Many2Many)
- - TO l3-network (Many2Many)
- - FROM availability-zone
- - FROM cloud-region
- - FROM oam-network
- - FROM pserver
- - FROM pnf
- - FROM vce
- - FROM vpls-pe
- - FROM volume-group
+ - 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( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
+
required:
- physical-location-id
- physical-location-type
type: array
items:
$ref: "#/definitions/complex"
- volume-group:
+ configuration:
description: |
- Persistent block-level storage.
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Port Mirror Configuration.
###### Related Nodes
- - TO complex (Many2Many)
- - TO tenant (Many2Many)
- - FROM cloud-region (is composed of volume-group)
- - FROM vf-module
- - FROM generic-vnf
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+
+ -(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
required:
- - volume-group-id
- - volume-group-name
- - vnf-type
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
properties:
- volume-group-id:
+ configuration-id:
type: string
- description: Unique ID of volume-group.
- volume-group-name:
+ description: UUID assigned to configuration.
+ management-option:
type: string
- description: Name of the volume group.
- heat-stack-id:
+ 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: Heat stack id corresponding to this volume-group
- vnf-type:
+ description: Name of the configuration.
+ configuration-type:
type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ 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 this volume-group
+ 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
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- volume-groups:
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ configurations:
description: |
- Collection of persistent block-level storage.
+ Collection of configurations
properties:
- volume-group:
+ configuration:
type: array
items:
- $ref: "#/definitions/volume-group"
- volume:
+ $ref: "#/definitions/configuration"
+ connector:
description: |
- Ephemeral Block storage volume.
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Collection of resource instances used to connect a variety of disparate inventory widgets
###### Related Nodes
- - FROM vserver (is composed of volume)
+ - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( 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
required:
- - volume-id
- - volume-selflink
+ - resource-instance-id
properties:
- volume-id:
- type: string
- description: Unique ID of block storage volume relative to the vserver.
- volume-selflink:
+ resource-instance-id:
type: string
- description: URL to endpoint where AAI can get more details
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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: "#/definitions/relationship"
- volumes:
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ connectors:
description: |
- Collection of ephemeral Block storage volumes.
+ Collection of resource instances used to connect a variety of disparate inventory widgets
properties:
- volume:
+ connector:
type: array
items:
- $ref: "#/definitions/volume"
- l3-interface-ipv4-address-list:
+ $ref: "#/definitions/connector"
+ constrained-element-set:
description: |
- IPv4 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ This is how we would capture constraints defining allowed sets of elements.
###### Related Nodes
- - TO l3-network (Many2Many)
- - TO subnet (Many2Many)
- - FROM l-interface (is composed of l3-interface-ipv4-address-list)
- - FROM vlan (is composed of l3-interface-ipv4-address-list)
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-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
required:
- - l3-interface-ipv4-address
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
properties:
- l3-interface-ipv4-address:
+ constrained-element-set-uuid:
type: string
- description: IP address
- l3-interface-ipv4-prefix-length:
- type: integer
- format: int64
- description: Prefix length, 32 for single address
- vlan-id-inner:
- type: integer
- format: int64
- description: Inner VLAN tag
- vlan-id-outer:
- type: integer
- format: int64
- description: Outer VLAN tag
- is-floating:
- type: boolean
- description: Indicator of fixed or floating address
- resource-version:
+ constraint-type:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- neutron-network-id:
+ check-type:
type: string
- description: Neutron network id of the interface that address belongs to
- neutron-subnet-id:
+ resource-version:
type: string
- description: Neutron id of subnet that address belongs to
+ element-choice-sets:
+ type: array
+ items:
+ $ref: "#/definitions/element-choice-set"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l3-interface-ipv6-address-list:
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/definitions/constrained-element-set"
+ ctag-assignment:
description: |
- IPv6 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- - TO l3-network (Many2Many)
- - TO subnet (Many2Many)
- - FROM l-interface (is composed of l3-interface-ipv6-address-list)
- - FROM vlan (is composed of l3-interface-ipv6-address-list)
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
required:
- - l3-interface-ipv6-address
+ - vlan-id-inner
properties:
- l3-interface-ipv6-address:
- type: string
- description: IP address
- l3-interface-ipv6-prefix-length:
- type: integer
- format: int64
- description: Prefix length, 128 for single address
vlan-id-inner:
type: integer
format: int64
- description: Inner VLAN tag
- vlan-id-outer:
- type: integer
- format: int64
- description: Outer VLAN tag
- is-floating:
- type: boolean
- description: Indicator of fixed or floating address
+ description: id.
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: "#/definitions/relationship"
- vlan:
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-assignment"
+ ctag-pool:
description: |
- Definition of vlan
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
+ A collection of C tags (vlan tags) grouped for a specific purpose.
###### Related Nodes
- - TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
- - TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
- - TO multicast-configuration (Many2Many)
- - TO logical-link (One2One)
- - FROM l-interface (is composed of vlan)
- - FROM service-instance
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
required:
- - vlan-interface
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
properties:
- vlan-interface:
- type: string
- description: String that identifies the interface
- vlan-id-inner:
- type: integer
- format: int64
- description: Inner VLAN tag
- vlan-id-outer:
- type: integer
- format: int64
- description: Outer VLAN tag
- resource-version:
- type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- speed-value:
+ target-pe:
type: string
- description: Captures the numeric part of the speed
- speed-units:
+ description: The Target provider edge router
+ availability-zone-name:
type: string
- description: Captures the units corresponding to the speed
- vlan-description:
+ description: Name of the availability zone
+ ctag-pool-purpose:
type: string
- description: Used to describe (the service associated with) the vlan
- backdoor-connection:
+ description: Describes what the intended purpose of this pool is.
+ ctag-values:
type: string
- description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
- vpn-id:
+ description: Comma separated list of ctags
+ resource-version:
type: string
- description: This indicates the customers VPN ID associated with this vlan
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l3-interface-ipv4-address-list:
- type: array
- items:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- l3-interface-ipv6-address-list:
+ ctag-pools:
+ properties:
+ ctag-pool:
type: array
items:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- vlans:
- properties:
- vlan:
- type: array
- items:
- $ref: "#/definitions/vlan"
- sriov-vf:
+ $ref: "#/definitions/ctag-pool"
+ customer:
description: |
- SR-IOV Virtual Function (not to be confused with virtual network function)
+ customer identifiers to provide linkage back to BSS information.
###### Related Nodes
- - FROM l-interface (is composed of sriov-vf)
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
required:
- - pci-id
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
properties:
- pci-id:
- type: string
- description: PCI ID used to identify the sriov-vf
- vf-vlan-filter:
+ global-customer-id:
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:
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ subscriber-name:
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:
+ description: Subscriber name, an alternate way to retrieve a customer.
+ subscriber-type:
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:
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ resource-version:
type: string
- description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-subscriptions:
+ type: array
+ items:
+ $ref: "#/definitions/service-subscription"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/definitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- neutron-network-id:
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/definitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
type: string
- description: Neutron network id of the interface
+ 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: "#/definitions/relationship"
- sriov-vfs:
+ dvs-switches:
description: |
- Collection of SR-IOV Virtual Functions.
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
properties:
- sriov-vf:
+ dvs-switch:
type: array
items:
- $ref: "#/definitions/sriov-vf"
- l-interface:
+ $ref: "#/definitions/dvs-switch"
+ edge-prop-names:
description: |
- Logical interfaces, e.g., a vnic.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
- - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
- - TO logical-link (Many2Many)
- - TO vlan (comprises l-interface, Many2Many)
- - TO sriov-vf (comprises l-interface, One2One)
- - FROM generic-vnf (is composed of l-interface)
- - FROM lag-interface (is composed of l-interface)
- - FROM newvce (is composed of l-interface)
- - FROM p-interface (is composed of l-interface)
- - FROM vserver (is composed of l-interface)
- required:
- - interface-name
+ Internal map to define the properties of an edge and interpret the map EdgeRules
properties:
- interface-name:
+ edgeLabel:
type: string
- description: Name given to the interface
- interface-role:
+ direction:
type: string
- description: E.g., CUSTOMER, UPLINK, etc.
- v6-wan-link-ip:
+ multiplicityRule:
type: string
- description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
- selflink:
+ isParent:
+ type: boolean
+ usesResource:
+ type: boolean
+ hasDelTarget:
+ type: boolean
+ SVC-INFRA:
+ type: boolean
+ SVC-INFRA-REV:
+ type: boolean
+ edge-tag-query-request:
+ properties:
+ edge-tag:
type: string
- description: URL to endpoint where AAI can get more details
- interface-id:
+ result-detail:
type: string
- description: ID of interface
- macaddr:
+ start-node-type:
type: string
- description: MAC address for the interface
- network-name:
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/definitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/definitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/definitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/definitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( 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
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ properties:
+ element-choice-set-uuid:
type: string
- description: Name of the network
- management-option:
+ element-choice-set-name:
+ type: string
+ cardinality:
type: string
- description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
resource-version:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- vlans:
- type: array
- items:
- $ref: "#/definitions/vlan"
- sriov-vfs:
+ model-elements:
type: array
items:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/model-element"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l3-interface-ipv4-address-list:
+ element-choice-sets:
+ properties:
+ element-choice-set:
type: array
items:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- l3-interface-ipv6-address-list:
+ $ref: "#/definitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
+ required:
+ - group-uuid
+ - resource-uuid
+ 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: "#/definitions/relationship"
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
type: array
items:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- l-interfaces:
+ $ref: "#/definitions/entitlement"
+ esr-ems:
description: |
- Collection of logical interfaces.
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
+ required:
+ - ems-id
properties:
- l-interface:
+ 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: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-ems-list:
+ properties:
+ esr-ems:
type: array
items:
- $ref: "#/definitions/l-interface"
- vserver:
+ $ref: "#/definitions/esr-ems"
+ esr-system-info:
description: |
- Virtual Servers, aka virtual machine or VM.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO flavor (Many2One)
- - TO image (Many2One)
- - TO l-interface (comprises vserver, Many2Many)
- - TO pserver (Many2One)
- - TO volume (comprises vserver, Many2Many)
- - TO vnfc (Many2Many)
- - TO snapshot (One2One)
- - TO vf-module (Many2One)
- - FROM generic-vnf
- - FROM tenant (is composed of vserver)
- - FROM vce
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
required:
- - vserver-id
- - vserver-name
- - vserver-selflink
- - in-maint
- - is-closed-loop-disabled
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
properties:
- vserver-id:
+ esr-system-info-id:
type: string
- description: Unique identifier for this vserver relative to its tenant
- vserver-name:
+ description: Unique ID of esr system info.
+ system-name:
type: string
- description: Name of vserver
- vserver-name2:
+ description: name of external system.
+ type:
type: string
- description: Alternative name of vserver
- prov-status:
+ description: type of external systems.
+ vendor:
type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- vserver-selflink:
+ description: vendor of external systems.
+ version:
type: string
- description: URL to endpoint where AAI can get more details
- in-maint:
+ 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
- is-closed-loop-disabled:
+ 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.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- volumes:
- type: array
- items:
- $ref: "#/definitions/volume"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
type: array
- items:
- $ref: "#/definitions/l-interface"
- vservers:
+ items:
+ $ref: "#/definitions/esr-system-info"
+ esr-thirdparty-sdnc:
description: |
- Collection of virtual Servers, aka virtual machines or VMs.
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
+ required:
+ - thirdparty-sdnc-id
properties:
- vserver:
+ 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: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
type: array
items:
- $ref: "#/definitions/vserver"
- tenant:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ esr-vnfm:
description: |
- Openstack tenant
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Persist VNFM address information used by VF-C.
###### Related Nodes
- - TO l3-network (Many2Many)
- - TO service-subscription (Many2Many)
- - TO vserver (comprises tenant, One2Many)
- - FROM cloud-region (is composed of tenant)
- - FROM group-assignment
- - FROM volume-group
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
required:
- - tenant-id
- - tenant-name
+ - vnfm-id
properties:
- tenant-id:
+ vnfm-id:
type: string
- description: Unique id relative to the cloud-region.
- tenant-name:
+ description: Unique ID of VNFM.
+ vim-id:
type: string
- description: Readable name of tenant
+ 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.
- vservers:
+ esr-system-info-list:
+ type: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
type: array
- items:
- $ref: "#/definitions/vserver"
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
+ required:
+ - evc-id
+ 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
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- tenants:
- description: |
- Collection of openstack tenants.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ evcs:
properties:
- tenant:
+ evc:
type: array
items:
- $ref: "#/definitions/tenant"
+ $ref: "#/definitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/definitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/definitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ extra-property:
+ properties:
+ property-name:
+ type: string
flavor:
description: |
Openstack flavor.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- - FROM cloud-region (is composed of flavor)
- - FROM vserver
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to VSERVER
+
required:
- flavor-id
- flavor-name
type: array
items:
$ref: "#/definitions/flavor"
- group-assignment:
+ forwarder:
description: |
- Openstack group-assignment used to store exclusivity groups (EG).
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Entity describing a sequenced segment of forwarding path
###### Related Nodes
- - TO tenant (Many2Many)
- - TO pserver (One2Many)
- - FROM cloud-region (is composed of group-assignment)
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(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
required:
- - group-id
- - group-type
- - group-name
+ - sequence
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:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ description: ingress, intermediate, egress
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- group-assignments:
- description: |
- Collection of openstack group assignments
- properties:
- group-assignment:
- type: array
- items:
- $ref: "#/definitions/group-assignment"
- snapshot:
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evc:
description: |
- Openstack snapshot
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ forwarder object is an optional child object of the Configuration object.
###### Related Nodes
- - FROM cloud-region (is composed of snapshot)
- - FROM vserver
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
required:
- - snapshot-id
+ - forwarder-evc-id
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:
+ forwarder-evc-id:
type: string
- description: The vendor of the application.
- application-version:
+ description: Key for forwarder-evc object
+ circuit-id:
type: string
- description: The version of the application.
- snapshot-selflink:
+ 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: URL to endpoint where AAI can get more details
- prev-snapshot-id:
+ description: Internal VLAN.
+ svlan:
type: string
- description: This field contains the UUID of the previous snapshot (if any).
- resource-version:
+ description: SVLAN value for ingress of egress forwarder.
+ cvlan:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ description: CVLAN value for ingress of egress forwarder.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- snapshots:
- description: |
- Collection of openstack snapshots
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evcs:
properties:
- snapshot:
+ forwarder-evc:
type: array
items:
- $ref: "#/definitions/snapshot"
- metadatum:
+ $ref: "#/definitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder"
+ forwarding-path:
description: |
- Key/value pairs
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
###### Related Nodes
- - FROM image (is composed of metadatum)
- - FROM model (is composed of metadatum)
- - FROM service-instance (is composed of metadatum)
- - FROM connector (is composed of metadatum)
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( 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
required:
- - metaname
- - metaval
+ - forwarding-path-id
+ - forwarding-path-name
properties:
- metaname:
+ forwarding-path-id:
type: string
- metaval:
+ description: Unique ID of this FP
+ forwarding-path-name:
type: string
+ description: Name of the FP
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
resource-version:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- metadata:
- description: |
- Collection of metadatum (key/value pairs)
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ 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: "#/definitions/forwarder"
+ forwarding-paths:
properties:
- metadatum:
+ forwarding-path:
type: array
items:
- $ref: "#/definitions/metadatum"
- image:
+ $ref: "#/definitions/forwarding-path"
+ generic-vnf:
description: |
- Openstack image.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
+ General purpose VNF
###### Related Nodes
- - TO metadatum (comprises image, Many2Many)
- - FROM cloud-region (is composed of image)
- - FROM vserver
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, 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)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo 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( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
required:
- - image-id
- - image-name
- - image-os-distro
- - image-os-version
- - image-selflink
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ - in-maint
+ - is-closed-loop-disabled
properties:
- image-id:
+ vnf-id:
type: string
- description: Image id, expected to be unique across cloud region
- image-name:
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-name:
type: string
- description: Image name
- image-architecture:
+ description: Name of VNF.
+ vnf-name2:
type: string
- description: Operating system architecture.
- image-os-distro:
+ description: Alternate name of VNF.
+ vnf-type:
type: string
- description: The common name of the operating system distribution in lowercase
- image-os-version:
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
type: string
- description: The operating system version as specified by the distributor.
- application:
+ description: Unique identifier of service from ASDC
+ regional-resource-zone:
type: string
- description: The application that the image instantiates.
- application-vendor:
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
type: string
- description: The vendor of the application.
- application-version:
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-state:
type: string
- description: The version of the application.
- image-selflink:
+ description: Indicator for whether the resource is considered operational
+ license-key:
type: string
- description: URL to endpoint where AAI can get more details
- resource-version:
+ description: License key
+ equipment-role:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- metadata:
- type: array
- items:
- $ref: "#/definitions/metadatum"
- images:
- description: |
- Collectio of Openstack images.
- properties:
- image:
- type: array
- items:
- $ref: "#/definitions/image"
- dvs-switch:
- 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.
- ###### Related Nodes
- - TO availability-zone (Many2Many)
- - FROM cloud-region (is composed of dvs-switch)
- required:
- - switch-name
- - vcenter-url
- properties:
- switch-name:
+ description: Client should send valid enumerated value
+ orchestration-status:
type: string
- description: DVS switch name
- vcenter-url:
+ description: Orchestration status of this VNF, used by MSO.
+ heat-stack-id:
type: string
- description: URL used to reach the vcenter
- resource-version:
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- dvs-switches:
- description: |
- Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
- properties:
- dvs-switch:
- type: array
- items:
- $ref: "#/definitions/dvs-switch"
- oam-network:
- description: |
- OAM network, to be deprecated shortly. Do not use for new purposes.
- ###### Related Nodes
- - TO complex (Many2Many)
- - TO service-capability (Many2Many)
- - FROM cloud-region (is composed of oam-network)
- required:
- - network-uuid
- - network-name
- - cvlan-tag
- properties:
- network-uuid:
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
type: string
- description: UUID of the network. Unique across a cloud-region
- network-name:
+ description: identifier of managed by company or customer
+ ipv4-oam-address:
type: string
- description: Name of the network.
- cvlan-tag:
+ 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
format: int64
- description: cvlan-id
- ipv4-oam-gateway-address:
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vcpu-units:
type: string
- description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
- ipv4-oam-gateway-address-prefix-length:
+ description: units associated with vcpu, used for VNFs with no vservers/flavors
+ vmemory:
type: integer
- format: int32
- description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors
+ 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.
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- oam-networks:
- description: |
- Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
- properties:
- oam-network:
- type: array
- items:
- $ref: "#/definitions/oam-network"
- availability-zone:
- description: |
- Availability zone, a collection of compute hosts/pservers
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
- ###### Related Nodes
- - TO complex (Many2Many)
- - TO service-capability (Many2Many)
- - FROM cloud-region (is composed of availability-zone)
- - FROM ctag-pool
- - FROM dvs-switch
- - FROM generic-vnf
- - FROM pserver
- - FROM vce
- required:
- - availability-zone-name
- - hypervisor-type
- properties:
- availability-zone-name:
+ summary-status:
type: string
- description: Name of the availability zone. Unique across a cloud region
- hypervisor-type:
+ description: details regarding the generic-vnf operation
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ persona-model-id:
type: string
- description: Type of hypervisor. Source of truth should define valid values.
- operational-state:
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
type: string
- description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
- resource-version:
+ description: the ASDC model version for this resource or service model.
+ model-version-id:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ 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.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- availability-zones:
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ vf-modules:
+ type: array
+ items:
+ $ref: "#/definitions/vf-module"
+ generic-vnfs:
description: |
- Collection of availability zones
+ Collection of VNFs
properties:
- availability-zone:
+ generic-vnf:
type: array
items:
- $ref: "#/definitions/availability-zone"
- cloud-region:
+ $ref: "#/definitions/generic-vnf"
+ group-assignment:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation.
- ###### Default Delete Scope
- THIS_NODE_ONLY
- ###### Related Nodes
- - TO complex (Many2One)
- - TO l3-network (Many2Many)
- - TO tenant (comprises cloud-region, One2Many)
- - TO image (comprises cloud-region, One2Many)
- - TO flavor (comprises cloud-region, One2Many)
- - TO availability-zone (comprises cloud-region, One2Many)
- - TO oam-network (comprises cloud-region, One2Many)
- - TO dvs-switch (comprises cloud-region, One2Many)
- - TO volume-group (comprises cloud-region, One2Many)
- - TO group-assignment (comprises cloud-region, One2Many)
- - TO snapshot (comprises cloud-region, One2Many)
- - FROM pserver
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
required:
- - cloud-owner
- - cloud-region-id
+ - group-id
+ - group-type
+ - group-name
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:
+ group-id:
type: string
- description: Software version employed at the site
- identity-url:
+ description: Group id, expected to be unique across cloud-region.
+ group-type:
type: string
- description: URL of the keystone identity service
- cloud-zone:
+ description: Group type - the type of group this instance refers to
+ group-name:
type: string
- description: Zone where the cloud is homed
- complex-name:
+ description: Group name - name assigned to the group
+ group-description:
type: string
- description: complex name for cloud-region instance
+ 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.
- volume-groups:
- type: array
- items:
- $ref: "#/definitions/volume-group"
- tenants:
- type: array
- items:
- $ref: "#/definitions/tenant"
- flavors:
- type: array
- items:
- $ref: "#/definitions/flavor"
- group-assignments:
- type: array
- items:
- $ref: "#/definitions/group-assignment"
- snapshots:
- type: array
- items:
- $ref: "#/definitions/snapshot"
- images:
- type: array
- items:
- $ref: "#/definitions/image"
- dvs-switches:
- type: array
- items:
- $ref: "#/definitions/dvs-switch"
- oam-networks:
- type: array
- items:
- $ref: "#/definitions/oam-network"
- availability-zones:
- type: array
- items:
- $ref: "#/definitions/availability-zone"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- cloud-regions:
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
properties:
- cloud-region:
+ group-assignment:
type: array
items:
- $ref: "#/definitions/cloud-region"
- network-profile:
+ $ref: "#/definitions/group-assignment"
+ host-route:
description: |
- Network profile populated by SDN-GP for SNMP
###### Related Nodes
- - FROM generic-vnf
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
required:
- - nm-profile-name
+ - host-route-id
+ - route-prefix
+ - next-hop
properties:
- nm-profile-name:
+ host-route-id:
type: string
- description: Unique name of network profile.
- community-string:
+ description: host-route id
+ route-prefix:
type: string
- description: Encrypted SNMP community 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.
type: array
items:
$ref: "#/definitions/relationship"
- network-profiles:
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
+ hpa-capabilities:
description: |
- Collection of network profiles
+ Collection of HPA Capabilities
properties:
- network-profile:
+ hpa-capability:
type: array
items:
- $ref: "#/definitions/network-profile"
- p-interface:
+ $ref: "#/definitions/hpa-capability"
+ hpa-capability:
description: |
- Physical interface (e.g., nic)
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
+ Represents a HPA capability
###### Related Nodes
- - TO l-interface (comprises p-interface, Many2Many)
- - TO physical-link (Many2Many)
- - TO logical-link (Many2One)
- - FROM lag-interface
- - FROM pserver (is composed of p-interface)
- - FROM pnf (is composed of p-interface)
- - FROM vpls-pe (is composed of p-interface)
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
required:
- - interface-name
+ - hpa-capability-id
+ - hpa-feature
properties:
- interface-name:
- type: string
- description: Name that identifies the physical interface
- speed-value:
+ hpa-capability-id:
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:
+ description: UUID to uniquely identify a HPA capability
+ hpa-feature:
type: string
- description: CLEI or other specification for p-interface hardware.
- interface-role:
+ description: Name of the HPACapability
+ hpa-version:
type: string
- description: Role specification for p-interface hardware.
- interface-type:
+ description: HPA schema version
+ architecture:
type: string
- description: Indicates the physical properties of the interface.
+ description: Hardware architecture
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
- p-interfaces:
- description: |
- Collection of physical interfaces.
- properties:
- p-interface:
+ hpa-feature-attributes:
type: array
items:
- $ref: "#/definitions/p-interface"
- lag-interface:
+ $ref: "#/definitions/hpa-feature-attributes"
+ hpa-feature-attributes:
description: |
- Link aggregate interface
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
+ HPA Capability Feature attributes
###### Related Nodes
- - TO lag-link (Many2Many)
- - TO p-interface (Many2Many)
- - TO l-interface (comprises lag-interface, Many2Many)
- - FROM generic-vnf (is composed of lag-interface)
- - FROM pserver (is composed of lag-interface)
- - FROM pnf (is composed of lag-interface)
- - FROM vpls-pe (is composed of lag-interface)
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
required:
- - interface-name
+ - hpa-attribute-key
properties:
- interface-name:
+ hpa-attribute-key:
type: string
- description: Name that identifies the link aggregate interface
+ 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.
- speed-value:
- type: string
- description: Captures the numeric part of the speed
- speed-units:
- type: string
- description: Captures the units corresponding to the speed
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
- lag-interfaces:
- description: |
- Collection of link aggregate interfaces.
- properties:
- lag-interface:
- type: array
- items:
- $ref: "#/definitions/lag-interface"
- pserver:
+ image:
description: |
- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
- ###### Related Nodes
- - TO complex (Many2One)
- - TO cloud-region (Many2One)
- - TO availability-zone (Many2One)
- - TO lag-interface (comprises pserver, Many2Many)
- - TO p-interface (comprises pserver, Many2Many)
- - FROM generic-vnf
- - FROM group-assignment
- - FROM vserver
- - FROM logical-link
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( 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
+
required:
- - hostname
- - in-maint
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
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
- format: int32
- description: Number of cpus
- disk-in-gigabytes:
- type: integer
- format: int32
- description: Disk size, in GBs
- ram-in-megabytes:
- type: integer
- format: int32
- description: RAM size, in MBs
- equip-type:
+ image-id:
type: string
- description: Equipment type. Source of truth should define valid values.
- equip-vendor:
+ description: Image id, expected to be unique across cloud region
+ image-name:
type: string
- description: Equipment vendor. Source of truth should define valid values.
- equip-model:
+ description: Image name
+ image-architecture:
type: string
- description: Equipment model. Source of truth should define valid values.
- fqdn:
+ description: Operating system architecture.
+ image-os-distro:
type: string
- description: Fully-qualified domain name
- pserver-selflink:
+ description: The common name of the operating system distribution in lowercase
+ image-os-version:
type: string
- description: URL to endpoint where AAI can get more details
- ipv4-oam-address:
+ description: The operating system version as specified by the distributor.
+ application:
type: string
- description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
- serial-number:
+ description: The application that the image instantiates.
+ application-vendor:
type: string
- description: Serial number, may be queried
- pserver-id:
+ description: The vendor of the application.
+ application-version:
type: string
- description: ID of Pserver
- internet-topology:
+ description: The version of the application.
+ image-selflink:
type: string
- description: internet topology of Pserver
- in-maint:
- type: boolean
+ 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.
- pserver-name2:
- type: string
- description: alternative pserver name
- purpose:
- type: string
- description: purpose of pserver
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
- type: array
- items:
- $ref: "#/definitions/p-interface"
- lag-interfaces:
+ metadata:
type: array
items:
- $ref: "#/definitions/lag-interface"
- pservers:
+ $ref: "#/definitions/metadatum"
+ images:
description: |
- Collection of compute hosts.
+ Collectio of Openstack images.
properties:
- pserver:
+ image:
type: array
items:
- $ref: "#/definitions/pserver"
- virtual-data-center:
- description: |
- Virtual organization of cloud infrastructure elements in a data center context
- ###### Related Nodes
- - TO generic-vnf (Many2Many)
- - TO logical-link (Many2Many)
- - FROM connector
- required:
- - vdc-id
- - vdc-name
+ $ref: "#/definitions/image"
+ include-node-filter:
properties:
- vdc-id:
- type: string
- description: Unique ID of the vdc
- vdc-name:
- type: string
- description: Name of the virtual data center
- resource-version:
+ include-node-type:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- virtual-data-centers:
+ instance-filter:
description: |
- Virtual organization of cloud infrastructure elements in a data center context
- properties:
- virtual-data-center:
- type: array
- items:
- $ref: "#/definitions/virtual-data-center"
- cloud-infrastructure:
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
description: |
- Namespace for cloud infrastructure.
+ InstanceFilters for performing a named-query or model query
properties:
- complexes:
- type: array
- items:
- $ref: "#/definitions/complex"
- cloud-regions:
- type: array
- items:
- $ref: "#/definitions/cloud-region"
- network-profiles:
- type: array
- items:
- $ref: "#/definitions/network-profile"
- pservers:
- type: array
- items:
- $ref: "#/definitions/pserver"
- virtual-data-centers:
+ instance-filter:
type: array
- items:
- $ref: "#/definitions/virtual-data-center"
- connector:
+ items:
+ $ref: "#/definitions/instance-filter"
+ instance-group:
description: |
- Collection of resource instances used to connect a variety of disparate inventory widgets
+ General mechanism for grouping instances
###### Related Nodes
- - TO virtual-data-center (Many2Many)
- - TO metadatum (comprises connector, Many2Many)
- - FROM service-instance
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+
required:
- - resource-instance-id
+ - id
+ - description
+ - type
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.
- persona-model-id:
+ id:
type: string
- description: the ASDC model id for this resource or service model.
- persona-model-version:
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
type: string
- description: the ASDC model version for this resource or service model.
- model-version-id:
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ resource-version:
type: string
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description: Concurrency value
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- metadata:
- type: array
- items:
- $ref: "#/definitions/metadatum"
- connectors:
+ instance-groups:
description: |
- Collection of resource instances used to connect a variety of disparate inventory widgets
+ Collection of openstack route table references
properties:
- connector:
+ instance-group:
type: array
items:
- $ref: "#/definitions/connector"
- service-instance:
- description: |
- Instance of a service
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO cvlan-tag (Many2Many)
- - TO connector (Many2Many)
- - TO metadatum (comprises service-instance, Many2Many)
- - TO logical-link (Many2Many)
- - TO vlan (One2Many)
- - TO service-instance (One2Many)
- - FROM generic-vnf
- - FROM l3-network
- - FROM service-subscription (is composed of service-instance)
- - FROM vce
- - FROM service-instance
- required:
- - service-instance-id
+ $ref: "#/definitions/instance-group"
+ inventory:
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.
- persona-model-id:
+ search:
+ type: object
+ $ref: "#/definitions/search"
+ actions:
+ type: object
+ $ref: "#/definitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/definitions/cloud-infrastructure"
+ business:
+ type: object
+ $ref: "#/definitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/definitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/definitions/network"
+ inventory-item:
+ properties:
+ inventory-item-type:
type: string
- description: the ASDC model id for this resource or service model.
- persona-model-version:
+ inventory-item-link:
type: string
- description: the ASDC model version for this resource or service model.
- model-version-id:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/definitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ property-value:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
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:
+ extra-properties:
+ type: object
+ $ref: "#/definitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/definitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-response-item"
+ ipsec-configuration:
+ 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( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
+ required:
+ - ipsec-configuration-id
+ properties:
+ ipsec-configuration-id:
type: string
- description: Indicates the total bandwidth to be used for this service.
- bandwidth-up-wan1:
+ description: UUID of this configuration
+ requested-vig-address-type:
type: string
- description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
- bandwidth-down-wan1:
+ description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
+ requested-encryption-strength:
type: string
- description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
- bandwidth-up-wan2:
+ description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
+ requested-dmz-type:
type: string
- description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
- bandwidth-down-wan2:
+ description: can offer a shared DMZ or a DMZ specific to a customer
+ shared-dmz-network-address:
type: string
- description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
- vhn-portal-url:
+ description: Network address of shared DMZ
+ requested-customer-name:
type: string
- description: URL customers will use to access the vHN Portal.
- service-instance-location-id:
+ description: If the DMZ is a custom DMZ, this field will indicate the customer information
+ ike-version:
type: string
- description: An identifier that customers assign to the location where this service is being used.
+ 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, ,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.
type: array
items:
$ref: "#/definitions/relationship"
- metadata:
+ vig-servers:
type: array
items:
- $ref: "#/definitions/metadatum"
- service-instances:
- description: |
- Collection of service instances
+ $ref: "#/definitions/vig-server"
+ ipsec-configurations:
properties:
- service-instance:
+ ipsec-configuration:
type: array
items:
- $ref: "#/definitions/service-instance"
- service-subscription:
+ $ref: "#/definitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
description: |
- Object that group service instances.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
+ Logical interfaces, e.g., a vnic.
###### Related Nodes
- - TO service-instance (comprises service-subscription, Many2Many)
- - FROM customer (is composed of service-subscription)
- - FROM tenant
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
required:
- - service-type
+ - interface-name
properties:
- service-type:
+ interface-name:
type: string
- description: Value defined by orchestration to identify this service across ECOMP.
- temp-ub-sub-account-id:
+ description: Name given to the interface
+ interface-role:
type: string
- description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ 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
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- service-instances:
+ vlans:
type: array
items:
- $ref: "#/definitions/service-instance"
+ $ref: "#/definitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-vf"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- service-subscriptions:
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ l-interfaces:
description: |
- Collection of objects that group service instances.
+ Collection of logical interfaces.
properties:
- service-subscription:
+ l-interface:
type: array
items:
- $ref: "#/definitions/service-subscription"
- customer:
+ $ref: "#/definitions/l-interface"
+ l3-interface-ipv4-address-list:
description: |
- customer identifiers to provide linkage back to BSS information.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
+ IPv4 Address Range
###### Related Nodes
- - TO service-subscription (comprises customer, Many2Many)
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
required:
- - global-customer-id
- - subscriber-name
- - subscriber-type
+ - l3-interface-ipv4-address
properties:
- global-customer-id:
- type: string
- description: Global customer id used across ECOMP to uniquely identify customer.
- subscriber-name:
- type: string
- description: Subscriber name, an alternate way to retrieve a customer.
- subscriber-type:
+ l3-interface-ipv4-address:
type: string
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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.
- service-subscriptions:
- type: array
- items:
- $ref: "#/definitions/service-subscription"
+ 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: "#/definitions/relationship"
- customers:
- description: |
- Collection of customer identifiers to provide linkage back to BSS information.
- properties:
- customer:
- type: array
- items:
- $ref: "#/definitions/customer"
- business:
+ l3-interface-ipv6-address-list:
description: |
- Namespace for business related constructs
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
+ required:
+ - l3-interface-ipv6-address
properties:
- connectors:
- type: array
- items:
- $ref: "#/definitions/connector"
- customers:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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: "#/definitions/customer"
- vnf-image:
+ $ref: "#/definitions/relationship"
+ l3-network:
description: |
- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ Generic network definition
###### Related Nodes
- - FROM generic-vnf
+ - 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 cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - 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 ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
required:
- - vnf-image-uuid
- - application
- - application-vendor
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
properties:
- vnf-image-uuid:
+ network-id:
type: string
- description: Unique ID of this asset
- application:
+ description: Network ID, should be uuid. Unique across A&AI.
+ network-name:
type: string
- description: The application that the image instantiates.
- application-vendor:
+ description: Name of the network, governed by some naming convention..
+ network-type:
type: string
- description: The vendor of the application.
- application-version:
+ description: Type of the network - who defines these values?
+ network-role:
type: string
- description: The version of the application.
- selflink:
+ description: Role the network plans - who defines these values?
+ network-technology:
type: string
- description: URL to endpoint where AAI can get more details
+ 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
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
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
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ 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.
+ subnets:
+ type: array
+ items:
+ $ref: "#/definitions/subnet"
+ ctag-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-assignment"
+ segmentation-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/segmentation-assignment"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- vnf-images:
- description: |
- Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
+ l3-networks:
properties:
- vnf-image:
+ l3-network:
type: array
items:
- $ref: "#/definitions/vnf-image"
- service:
+ $ref: "#/definitions/l3-network"
+ lag-interface:
description: |
- Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-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
required:
- - service-id
- - service-description
+ - interface-name
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:
+ interface-name:
type: string
- description: URL to endpoint where AAI can get more details
+ description: Name that identifies the link aggregate interface
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- service-version:
+ speed-value:
type: string
- description: service version
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- services:
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ lag-interfaces:
description: |
- Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ Collection of link aggregate interfaces.
properties:
- service:
+ lag-interface:
type: array
items:
- $ref: "#/definitions/service"
- service-capability:
+ $ref: "#/definitions/lag-interface"
+ lag-link:
description: |
- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ LAG links can connect lag-interfaces
###### Related Nodes
- - FROM availability-zone
- - FROM oam-network
+ - 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
required:
- - service-type
- - vnf-type
+ - link-name
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:
+ link-name:
type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- service-capabilities:
+ lag-links:
description: |
- Collection of service capabilities.
+ Collection of link aggregation connections
properties:
- service-capability:
+ lag-link:
type: array
items:
- $ref: "#/definitions/service-capability"
- element-choice-set:
+ $ref: "#/definitions/lag-link"
+ license:
description: |
- This is how we would capture constraints defining allowed sets of elements.
+ Metadata for license group.
###### Related Nodes
- - TO model-element (comprises element-choice-set, One2Many)
- - FROM constrained-element-set (is composed of element-choice-set)
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
required:
- - element-choice-set-uuid
- - element-choice-set-name
+ - group-uuid
+ - resource-uuid
properties:
- element-choice-set-uuid:
- type: string
- element-choice-set-name:
+ group-uuid:
type: string
- cardinality:
+ 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
- model-elements:
- type: array
- items:
- $ref: "#/definitions/model-element"
+ description: Concurrency value
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- element-choice-sets:
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
properties:
- element-choice-set:
+ license:
type: array
items:
- $ref: "#/definitions/element-choice-set"
- constrained-element-set:
+ $ref: "#/definitions/license"
+ line-of-business:
description: |
- This is how we would capture constraints defining allowed sets of elements.
+ describes a line-of-business
###### Related Nodes
- - TO element-choice-set (comprises constrained-element-set, One2Many)
- - FROM model-element (is composed of constrained-element-set)
- - FROM model-constraint (is composed of constrained-element-set)
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
required:
- - constrained-element-set-uuid
- - constraint-type
- - check-type
+ - line-of-business-name
properties:
- constrained-element-set-uuid:
- type: string
- constraint-type:
- type: string
- check-type:
+ line-of-business-name:
type: string
+ description: Name of the line-of-business (product)
resource-version:
type: string
- element-choice-sets:
- type: array
- items:
- $ref: "#/definitions/element-choice-set"
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- constrained-element-sets:
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
properties:
- constrained-element-set:
+ line-of-business:
type: array
items:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/definitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, ONE2MANY)
+ - 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)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ required:
+ - link-name
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ 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.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/definitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+ - TO model( metadatum BelongsTo model, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
+ required:
+ - metaname
+ - metaval
+ 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.
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-element isA model, MANY2ONE)
+ - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+ - FROM model-element( model-element isA model, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -(2) IF this MODEL node is deleted, this TO node is DELETED also
+ -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
+
+ required:
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ 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-elements:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/definitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/definitions/instance-filters"
+ top-node-type:
+ type: string
model-constraint:
description: |
This is how we would capture constraints defining allowed sets of elements.
###### Related Nodes
- - TO constrained-element-set (comprises model-constraint, One2Many)
- - FROM model-element (is composed of model-constraint)
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( 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
required:
- model-constraint-uuid
- constrained-element-set-uuid-to-replace
model-element:
description: |
Defines how other models combine to make up a higher-level model.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- - TO model (Many2One)
- - TO model-element (comprises model-element, One2Many)
- - TO model-constraint (comprises model-element, One2Many)
- - TO constrained-element-set (comprises model-element, One2Many)
- - FROM model (is composed of model-element)
- - FROM element-choice-set (is composed of model-element)
- - FROM model-element (is composed of model-element)
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model( model-element isA model, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model (PARENT of model-element, model startsWith model-element)(3)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
required:
- model-element-uuid
- new-data-del-flag
type: array
items:
$ref: "#/definitions/model-element"
- model:
+ model-ver:
description: |
- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
+ 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 (Many2One)
- - TO model-element (comprises model, One2Many)
- - TO metadatum (comprises model, One2Many)
- - FROM model-element
- - FROM named-query
- - FROM named-query-element
+ - TO model( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM metadatum( metadatum 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
+
required:
- - model-name-version-id
- - model-type
+ - model-version-id
- model-name
- - model-id
- model-version
properties:
- model-name-version-id:
+ model-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
type: array
items:
$ref: "#/definitions/relationship"
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/definitions/model-ver"
models:
description: |
Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
type: array
items:
$ref: "#/definitions/model"
- related-lookup:
+ multicast-configuration:
description: |
- TBD
###### Related Nodes
- - FROM named-query-element (is composed of related-lookup)
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
required:
- - related-lookup-uuid
- - source-node-type
- - source-node-property
- - target-node-type
- - target-node-property
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
properties:
- related-lookup-uuid:
- type: string
- source-node-type:
- type: string
- source-node-property:
- type: string
- target-node-type:
+ multicast-configuration-id:
type: string
- target-node-property:
+ description: Unique id of multicast configuration.
+ multicast-protocol:
type: string
- property-collect-list:
+ 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: "#/definitions/relationship"
- related-lookups:
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
properties:
- related-lookup:
+ multicast-configuration:
type: array
items:
- $ref: "#/definitions/related-lookup"
- property-constraint:
+ $ref: "#/definitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/definitions/named-query"
+ named-query:
description: |
TBD
###### Related Nodes
- - FROM named-query-element (is composed of property-constraint)
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
required:
- - property-constraint-uuid
- - constraint-type
- - property-name
- - property-value
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
properties:
- property-constraint-uuid:
+ named-query-uuid:
type: string
- constraint-type:
+ named-query-name:
type: string
- property-name:
+ named-query-version:
type: string
- property-value:
+ required-input-param:
+ type: string
+ description:
type: string
resource-version:
type: string
- property-constraints:
- properties:
- property-constraint:
+ named-query-elements:
type: array
- items:
- $ref: "#/definitions/property-constraint"
+ items:
+ $ref: "#/definitions/named-query-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
named-query-element:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- - TO named-query-element (comprises named-query-element, Many2Many)
- - TO model (Many2One)
- - TO property-constraint (comprises named-query-element, One2Many)
- - TO related-lookup (comprises named-query-element, One2Many)
- - FROM named-query (is composed of named-query-element)
- - FROM named-query-element (is composed of named-query-element)
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(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
required:
- named-query-element-uuid
properties:
type: array
items:
$ref: "#/definitions/named-query-element"
- named-query:
+ network:
description: |
- TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO model (One2Many)
- - TO named-query-element (comprises named-query, One2One)
- required:
- - named-query-uuid
- - named-query-name
- - named-query-version
+ Namespace for network inventory resources.
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:
+ logical-links:
type: array
items:
- $ref: "#/definitions/named-query-element"
- relationship-list:
+ $ref: "#/definitions/logical-link"
+ site-pair-sets:
type: array
items:
- $ref: "#/definitions/relationship"
- named-queries:
- properties:
- named-query:
+ $ref: "#/definitions/site-pair-set"
+ vpn-bindings:
type: array
- items:
- $ref: "#/definitions/named-query"
- service-design-and-creation:
- description: |
- Namespace for objects managed by ASDC
- properties:
- vnf-images:
+ items:
+ $ref: "#/definitions/vpn-binding"
+ vpls-pes:
type: array
items:
- $ref: "#/definitions/vnf-image"
- services:
+ $ref: "#/definitions/vpls-pe"
+ multicast-configurations:
type: array
items:
- $ref: "#/definitions/service"
- service-capabilities:
+ $ref: "#/definitions/multicast-configuration"
+ vces:
type: array
items:
- $ref: "#/definitions/service-capability"
- models:
+ $ref: "#/definitions/vce"
+ vnfcs:
type: array
items:
- $ref: "#/definitions/model"
- named-queries:
+ $ref: "#/definitions/vnfc"
+ l3-networks:
type: array
items:
- $ref: "#/definitions/named-query"
- logical-link:
+ $ref: "#/definitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/definitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/definitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/definitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/definitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/definitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/definitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/definitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/definitions/route-table-reference"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/definitions/network-policy"
+ network-policy:
description: |
- Logical links generally connect l-interfaces but are used to express logical connectivity between two points
- ###### Default Delete Scope
- THIS_NODE_ONLY
- ###### Related Nodes
- - TO lag-link (Many2Many)
- - TO pnf (Many2Many)
- - TO logical-link (One2Many)
- - TO generic-vnf (Many2Many)
- - TO pserver (Many2Many)
- - FROM l-interface
- - FROM p-interface
- - FROM service-instance
- - FROM virtual-data-center
- - FROM vlan
- - FROM logical-link
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
required:
- - link-name
- - link-type
+ - network-policy-id
properties:
- link-name:
- type: string
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
- 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:
+ network-policy-id:
type: string
- description: Captures the units corresponding to the speed
- ip-version:
+ description: UUID representing unique key to this instance
+ network-policy-fqdn:
type: string
- description: v4, v6, or ds for dual stack
- routing-protocol:
+ description: Contrail FQDN for the policy
+ heat-stack-id:
type: string
- description: For example, static or BGP
+ 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.
- persona-model-id:
- type: string
- description: the ASDC model id for this resource or service model.
- persona-model-version:
- type: string
- description: the ASDC model version 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.
- 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.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- logical-links:
- description: |
- Collection of logical connections
- properties:
- logical-link:
- type: array
- items:
- $ref: "#/definitions/logical-link"
- class-of-service:
+ network-profile:
description: |
+ Network profile populated by SDN-GP for SNMP
###### Related Nodes
- - FROM site-pair (is composed of class-of-service)
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
required:
- - cos
+ - nm-profile-name
properties:
- cos:
- type: string
- description: unique identifier of probe
- probe-id:
+ nm-profile-name:
type: string
- description: identifier of probe
- probe-type:
+ description: Unique name of network profile.
+ community-string:
type: string
- description: type of probe
+ description: Encrypted SNMP community string
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- classes-of-service:
+ network-profiles:
description: |
- class-of-service of probe
+ Collection of network profiles
properties:
- class-of-service:
+ network-profile:
type: array
items:
- $ref: "#/definitions/class-of-service"
- site-pair:
+ $ref: "#/definitions/network-profile"
+ newvce:
description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
###### Related Nodes
- - TO class-of-service (comprises site-pair, Many2Many)
- - FROM routing-instance (is composed of site-pair)
+ - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
required:
- - site-pair-id
+ - vnf-id2
+ - vnf-name
+ - vnf-type
properties:
- site-pair-id:
+ vnf-id2:
type: string
- description: unique identifier of probe
- source-ip:
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ vnf-name:
type: string
- description: Prefix address
- destination-ip:
+ description: Name of VNF.
+ vnf-name2:
type: string
- description: Prefix address
- ip-version:
+ description: Alternate name of VNF.
+ vnf-type:
type: string
- description: ip version, v4, v6
- destination-hostname:
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ prov-status:
type: string
- description: Hostname of the destination equipment to which SLAs are measured against.
- destination-equip-type:
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-state:
type: string
- description: The type of destinatination equipment. Could be Router, etc.
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ 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.
- classes-of-service:
- type: array
- items:
- $ref: "#/definitions/class-of-service"
+ 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: "#/definitions/relationship"
- site-pairs:
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ newvces:
description: |
- probe within a set
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
properties:
- site-pair:
+ newvce:
type: array
items:
- $ref: "#/definitions/site-pair"
- routing-instance:
- description: |
- ###### Related Nodes
- - TO site-pair (comprises routing-instance, Many2Many)
- - FROM site-pair-set (is composed of routing-instance)
- required:
- - routing-instance-id
+ $ref: "#/definitions/newvce"
+ nodes:
properties:
- routing-instance-id:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-item-data"
+ notification-event:
+ properties:
+ cambria.partition:
type: string
- description: Unique id of routing instance
- rpm-owner:
+ notification-event-header:
+ type: object
+ $ref: "#/definitions/notification-event-header"
+ notification-event-header:
+ properties:
+ id:
type: string
- description: rpm owner
+ 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:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/definitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ 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
+ format: int64
+ description: cvlan-id
+ 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
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
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: "#/definitions/site-pair"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- routing-instances:
+ oam-networks:
description: |
- set of probes related to generic-vnf routing instance
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
properties:
- routing-instance:
+ oam-network:
type: array
items:
- $ref: "#/definitions/routing-instance"
- site-pair-set:
+ $ref: "#/definitions/oam-network"
+ operational-environment:
description: |
- Set of instances for probes used to measure service level agreements
+ It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
###### Related Nodes
- - TO routing-instance (comprises site-pair-set, Many2Many)
- - FROM generic-vnf
+ - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
required:
- - site-pair-set-id
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
properties:
- site-pair-set-id:
+ operational-environment-id:
type: string
- description: Unique id of site pair set.
+ 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.
- routing-instances:
- type: array
- items:
- $ref: "#/definitions/routing-instance"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- site-pair-sets:
+ operational-environments:
description: |
- Collection of sets of instances for probes related to generic-vnf
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
properties:
- site-pair-set:
+ operational-environment:
type: array
items:
- $ref: "#/definitions/site-pair-set"
- vpn-binding:
+ $ref: "#/definitions/operational-environment"
+ overloaded-model:
description: |
- VPN binding
- ###### Related Nodes
- - FROM l3-network
+ Allows for legacy POST of old-style and new-style models
required:
- - vpn-id
- - vpn-name
- - global-route-target
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
properties:
- vpn-id:
+ model-invariant-id:
type: string
- description: VPN ID, globally unique within A&AI
- vpn-name:
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-name-version-id:
type: string
- description: VPN Name
- global-route-target:
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-type:
type: string
- description: Number used to identify a VPN, globally unique in the network
- vpn-platform:
+ description: Type of the model, e.g., service, resource, widget, etc.
+ model-name:
type: string
- description: the platform associated with the VPN example AVPN, Mobility
+ 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:
+ type: object
+ $ref: "#/definitions/model-vers"
relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- description: l3-networks relate to vpn-bindings
- vpn-bindings:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ owning-entities:
+ description: |
+ Collection of owning-entities
properties:
- vpn-binding:
+ owning-entity:
type: array
items:
- $ref: "#/definitions/vpn-binding"
- vpls-pe:
+ $ref: "#/definitions/owning-entity"
+ owning-entity:
description: |
- VPLS Provider Edge routers.
+ describes an owning-entity
###### Related Nodes
- - TO complex (Many2Many)
- - TO ctag-pool (Many2Many)
- - TO p-interface (comprises vpls-pe, Many2Many)
- - TO lag-interface (comprises vpls-pe, Many2Many)
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
required:
- - equipment-name
+ - owning-entity-id
+ - owning-entity-name
properties:
- equipment-name:
+ owning-entity-id:
type: string
- prov-status:
+ description: UUID of an owning entity
+ owning-entity-name:
type: string
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- ipv4-oam-address:
+ description: Owning entity name
+ resource-version:
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:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+
+ -(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
+ required:
+ - interface-name
+ properties:
+ interface-name:
type: string
- description: Client should send valid enumerated value, e.g., VPLS-PE.
- vlan-id-outer:
- type: integer
- format: int64
- description: Temporary location for stag to get to VCE
+ description: Name that identifies the physical interface
+ 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.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
+ l-interfaces:
type: array
items:
+ $ref: "#/definitions/l-interface"
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
$ref: "#/definitions/p-interface"
- lag-interfaces:
+ physical-link:
+ 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
+ required:
+ - link-name
+ 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.
+ 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: "#/definitions/lag-interface"
- vpls-pes:
+ $ref: "#/definitions/relationship"
+ physical-links:
description: |
- Collection of VPLS Provider Edge routers
+ Collection of physical connections, typically between p-interfaces
properties:
- vpls-pe:
+ physical-link:
type: array
items:
- $ref: "#/definitions/vpls-pe"
- multicast-configuration:
+ $ref: "#/definitions/physical-link"
+ platform:
description: |
+ describes a platform
###### Related Nodes
- - FROM vlan
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
required:
- - multicast-configuration-id
- - multicast-protocol
- - rp-type
+ - platform-name
properties:
- multicast-configuration-id:
- type: string
- description: Unique id of multicast configuration.
- multicast-protocol:
- type: string
- description: protocol of multicast configuration
- rp-type:
+ platform-name:
type: string
- description: rp type of multicast configuration
+ description: Name of the platform
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- multicast-configurations:
+ platforms:
description: |
- multicast configuration of generic-vnf ip-address
+ Collection of platforms
properties:
- multicast-configuration:
+ platform:
type: array
items:
- $ref: "#/definitions/multicast-configuration"
- cvlan-tag-entry:
+ $ref: "#/definitions/platform"
+ pnf:
+ description: |
+ PNF represents a physical network function. typically equipment used in the D1 world.
+ ###### Related Nodes
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
required:
- - cvlan-tag
+ - pnf-name
+ - in-maint
properties:
- cvlan-tag:
- type: integer
- format: int64
- description: See mis-na-virtualization-platform.yang
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ 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 by company or customer
+ 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.
+ orchestration-status:
+ type: string
+ description: orchestration-status is the status of orchestration 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.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- cvlan-tags:
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
properties:
- cvlan-tag-entry:
+ pnf:
type: array
items:
- $ref: "#/definitions/cvlan-tag-entry"
+ $ref: "#/definitions/pnf"
port-group:
description: |
Used to capture the network interfaces of this VCE
###### Related Nodes
- - TO cvlan-tag (comprises port-group, Many2Many)
- - FROM vce (is composed of port-group)
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( 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
required:
- interface-id
- orchestration-status
type: array
items:
$ref: "#/definitions/port-group"
- vce:
+ project:
description: |
- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ describes the project
###### Related Nodes
- - TO availability-zone (Many2Many)
- - TO complex (Many2Many)
- - TO port-group (comprises vce, Many2Many)
- - TO vserver (Many2Many)
- - TO service-instance (Many2Many)
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
required:
- - vnf-id
- - vnf-name
- - vnf-type
+ - project-name
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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
- service-id:
- type: string
- description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
- 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-state:
- type: string
- description: Indicator for whether the resource is considered operational
- license-key:
- type: string
- description: License key
- 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:
+ project-name:
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: 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.
- ipv4-loopback0-address:
- type: string
- description: Loopback0 address
- entitlement-resource-uuid:
- type: string
- description: Entitlement resource uuid
- port-groups:
- type: array
- items:
- $ref: "#/definitions/port-group"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- vces:
+ projects:
description: |
- Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ Collection of projects
properties:
- vce:
+ project:
type: array
items:
- $ref: "#/definitions/vce"
- vnfc:
+ $ref: "#/definitions/project"
+ properties:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
- ###### Related Nodes
- - FROM vserver
- - FROM vf-module
- - FROM generic-vnf
- required:
- - vnfc-name
- - vnfc-function-code
- - vnfc-type
- - in-maint
- - is-closed-loop-disabled
+ Property holder for query properties or instance properties
properties:
- vnfc-name:
- type: string
- description: Unique ID of vnfc.
- vnfc-function-code:
+ property-name:
type: string
- description: function code
- vnfc-type:
+ property-value:
type: string
- description: type
- prov-status:
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
type: string
- description: prov status of this vnfc
- orchestration-status:
+ constraint-type:
type: string
- description: Orchestration status of this VNF, mastered by APP-C
- ipaddress-v4-oam-vip:
+ property-name:
type: string
- description: Oam V4 vip address of this vnfc
- in-maint:
- type: boolean
- is-closed-loop-disabled:
- type: boolean
- group-notation:
+ property-value:
type: string
- description: Group notation of VNFC
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: "#/definitions/relationship"
- vnfcs:
- description: |
- virtual network components associated with a vserver from application controller.
+ property-constraints:
properties:
- vnfc:
+ property-constraint:
type: array
items:
- $ref: "#/definitions/vnfc"
- subnet:
+ $ref: "#/definitions/property-constraint"
+ pserver:
description: |
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
###### Related Nodes
- - FROM l3-interface-ipv4-address-list
- - FROM l3-interface-ipv6-address-list
- - FROM l3-network (is composed of subnet)
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( 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 GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
required:
- - subnet-id
- - dhcp-enabled
+ - hostname
+ - in-maint
properties:
- subnet-id:
+ hostname:
type: string
- description: Subnet ID, should be UUID.
- subnet-name:
+ description: Value from executing hostname on the compute node.
+ ptnii-equip-name:
type: string
- description: Name associated with the subnet.
- neutron-subnet-id:
+ description: PTNII name
+ number-of-cpus:
+ type: integer
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ equip-type:
type: string
- description: Neutron id of this subnet
- gateway-address:
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
type: string
- description: gateway ip address
- network-start-address:
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
type: string
- description: network start address
- cidr-mask:
+ description: Equipment model. Source of truth should define valid values.
+ fqdn:
type: string
- description: cidr mask
- ip-version:
+ description: Fully-qualified domain name
+ pserver-selflink:
type: string
- description: ip version
- orchestration-status:
+ description: URL to endpoint where AAI can get more details
+ ipv4-oam-address:
type: string
- description: Orchestration status of this VNF, mastered by MSO
- dhcp-enabled:
- type: boolean
- dhcp-start:
+ description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
+ serial-number:
type: string
- description: the start address reserved for use by dhcp
- dhcp-end:
+ description: Serial number, may be queried
+ pserver-id:
type: string
- description: the last address reserved for use by dhcp
+ 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
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- subnets:
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ pservers:
+ description: |
+ Collection of compute hosts.
properties:
- subnet:
+ pserver:
type: array
items:
- $ref: "#/definitions/subnet"
- ctag-assignment:
+ $ref: "#/definitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/definitions/named-query"
+ model:
+ type: object
+ $ref: "#/definitions/model"
+ related-lookup:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ TBD
###### Related Nodes
- - FROM l3-network (is composed of ctag-assignment)
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
required:
- - vlan-id-inner
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
properties:
- vlan-id-inner:
- type: integer
- format: int64
- description: id.
+ 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
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- ctag-assignments:
+ related-lookups:
properties:
- ctag-assignment:
+ related-lookup:
type: array
items:
- $ref: "#/definitions/ctag-assignment"
- segmentation-assignment:
+ $ref: "#/definitions/related-lookup"
+ related-to-property:
+ 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:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/definitions/relationship-data"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ 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-list:
+ properties:
+ relationship:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ reserved-prop-names:
description: |
- Openstack segmentation assignment.
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Internal map to define some reserved properties of a vertex
+ 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
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/definitions/inventory-response-items"
+ result-data:
+ 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:
+ description: |
+ Openstack route table reference.
###### Related Nodes
- - FROM l3-network (is composed of segmentation-assignment)
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
required:
- - segmentation-id
+ - route-table-reference-id
+ - route-table-reference-fqdn
properties:
- segmentation-id:
+ 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
type: array
items:
$ref: "#/definitions/relationship"
- segmentation-assignments:
+ route-table-references:
description: |
- Collection of openstack segmentation assignments
+ Collection of openstack route table references
properties:
- segmentation-assignment:
+ route-table-reference:
type: array
items:
- $ref: "#/definitions/segmentation-assignment"
- l3-network:
+ $ref: "#/definitions/route-table-reference"
+ route-target:
description: |
- Generic network definition
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO vpn-binding (Many2Many)
- - TO subnet (comprises l3-network, Many2Many)
- - TO service-instance (Many2Many)
- - TO ctag-assignment (comprises l3-network, Many2Many)
- - TO network-policy (Many2Many)
- - TO segmentation-assignment (comprises l3-network, One2Many)
- - TO route-table-reference (Many2Many)
- - FROM cloud-region
- - FROM complex
- - FROM generic-vnf
- - FROM l3-interface-ipv4-address-list
- - FROM l3-interface-ipv6-address-list
- - FROM tenant
- - FROM vf-module
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
required:
- - network-id
- - network-name
- - is-bound-to-vpn
- - is-provider-network
- - is-shared-network
- - is-external-network
+ - global-route-target
+ - route-target-role
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:
+ global-route-target:
type: string
- description: Type of the network - who defines these values?
- network-role:
+ description: Number used to identify an RT, globally unique in the network
+ route-target-role:
type: string
- description: Role the network plans - who defines these values?
- network-technology:
+ description: Role assigned to this route target
+ resource-version:
type: string
- description: Network technology - who defines these values?
- neutron-network-id:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/definitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( 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
+ required:
+ - routing-instance-id
+ properties:
+ routing-instance-id:
type: string
- description: Neutron network id of this Interface
- is-bound-to-vpn:
- type: boolean
- service-id:
+ description: Unique id of routing instance
+ rpm-owner:
type: string
- description: Unique identifier of service from ASDC
- network-role-instance:
- type: integer
- format: int64
- description: network role instance
+ description: rpm owner
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- orchestration-status:
+ site-pairs:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/definitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/definitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/definitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/definitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/definitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/definitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/definitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/definitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
type: string
- description: Orchestration status of this VNF, mastered by MSO
- heat-stack-id:
+ filter-type:
type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
+ property-value:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- contrail-network-fqdn:
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/definitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
+ required:
+ - segmentation-id
+ properties:
+ segmentation-id:
type: string
- description: Contrail FQDN for the network
- persona-model-id:
+ description: Route Table Reference id, UUID assigned to this instance.
+ resource-version:
type: string
- description: the ASDC model id for this resource or service model.
- persona-model-version:
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/definitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
+ required:
+ - service-id
+ - service-description
+ properties:
+ service-id:
type: string
- description: the ASDC model version for this resource or service model.
- model-version-id:
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ service-description:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ description: Description of the service
+ service-selflink:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: URL to endpoint where AAI can get more details
+ resource-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:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-version:
type: string
- description: Name associated with the physical network.
- is-provider-network:
- type: boolean
- is-shared-network:
- type: boolean
- is-external-network:
- type: boolean
- subnets:
- type: array
- items:
- $ref: "#/definitions/subnet"
- ctag-assignments:
- type: array
- items:
- $ref: "#/definitions/ctag-assignment"
- segmentation-assignments:
- type: array
- items:
- $ref: "#/definitions/segmentation-assignment"
+ description: service version
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
- l3-networks:
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
properties:
- l3-network:
+ service-capability:
type: array
items:
- $ref: "#/definitions/l3-network"
- network-policy:
+ $ref: "#/definitions/service-capability"
+ service-capability:
description: |
+ Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
###### Related Nodes
- - FROM l3-network
+ - 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
+
required:
- - network-policy-id
+ - service-type
+ - vnf-type
properties:
- network-policy-id:
- type: string
- description: UUID representing unique key to this instance
- network-policy-fqdn:
+ service-type:
type: string
- description: Contrail FQDN for the policy
- heat-stack-id:
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ vnf-type:
type: string
- description: ID for the openStack Heat instance
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- network-policies:
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
properties:
- network-policy:
+ vnf-images:
type: array
- items:
- $ref: "#/definitions/network-policy"
- vf-module:
+ items:
+ $ref: "#/definitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/definitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/definitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/definitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/definitions/named-query"
+ service-instance:
description: |
- a deployment unit of VNFCs
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Instance of a service
###### Related Nodes
- - TO volume-group (One2One)
- - TO l3-network (Many2Many)
- - TO vnfc (One2Many)
- - FROM vserver
- - FROM generic-vnf (is composed of vf-module)
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(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
required:
- - vf-module-id
- - is-base-vf-module
+ - service-instance-id
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:
+ service-instance-id:
type: string
- description: orchestration status of this vf-module, mastered by MSO
- is-base-vf-module:
- type: boolean
- resource-version:
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ description: This field will store a name assigned to the service-instance.
persona-model-id:
type: string
description: the ASDC model id for this resource or service model.
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:
+ bandwidth-total:
type: string
- description: the Contrail unique ID for a service-instance
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ 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.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- vf-modules:
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ service-instances:
description: |
- Collection of vf-modules, a deployment unit of VNFCs
+ Collection of service instances
properties:
- vf-module:
+ service-instance:
type: array
items:
- $ref: "#/definitions/vf-module"
- generic-vnf:
+ $ref: "#/definitions/service-instance"
+ service-subscription:
description: |
- General purpose VNF
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
- ###### Related Nodes
- - TO license-key-resource (Many2Many)
- - TO l-interface (comprises generic-vnf, Many2Many)
- - TO availability-zone (Many2Many)
- - TO lag-interface (comprises generic-vnf, Many2Many)
- - TO l3-network (Many2Many)
- - TO pserver (Many2Many)
- - TO vnf-image (Many2One)
- - TO vserver (One2Many)
- - TO service-instance (Many2Many)
- - TO site-pair-set (Many2Many)
- - TO network-profile (Many2Many)
- - TO ipsec-configuration (Many2One)
- - TO vf-module (comprises generic-vnf, One2Many)
- - TO volume-group (One2Many)
- - TO vnfc (One2Many)
- - FROM virtual-data-center
- - FROM logical-link
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( 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
required:
- - vnf-id
- - vnf-name
- - vnf-type
- - in-maint
- - is-closed-loop-disabled
+ - service-type
properties:
- vnf-id:
- type: string
- description: Unique id of VNF. This is unique across the graph.
- vnf-name:
+ service-type:
type: string
- description: Name of VNF.
- vnf-name2:
+ description: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
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 and clients should expect changes to occur in the future to this field as ASDC matures.
- service-id:
- type: string
- description: Unique identifier of service from ASDC
- 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-state:
- type: string
- description: Indicator for whether the resource is considered operational
- license-key:
- type: string
- description: License key
- equipment-role:
+ description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ resource-version:
type: string
- description: Client should send valid enumerated value
- orchestration-status:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-instances:
+ type: array
+ items:
+ $ref: "#/definitions/service-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/definitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/definitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( 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
+ required:
+ - site-pair-id
+ properties:
+ site-pair-id:
type: string
- description: Orchestration status of this VNF, used by MSO.
- heat-stack-id:
+ description: unique identifier of probe
+ source-ip:
type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
+ description: Prefix address
+ destination-ip:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- management-option:
+ description: Prefix address
+ ip-version:
type: string
- description: identifier of managed by company or customer
- ipv4-oam-address:
+ description: ip version, v4, v6
+ destination-hostname:
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:
+ description: Hostname of the destination equipment to which SLAs are measured against.
+ destination-equip-type:
type: string
- description: v4 Loopback0 address
- nm-lan-v6-address:
+ description: The type of destinatination equipment. Could be Router, etc.
+ resource-version:
type: string
- description: v6 Loopback address
- management-v6-address:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ classes-of-service:
+ type: array
+ items:
+ $ref: "#/definitions/class-of-service"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ 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( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
type: string
- description: v6 management address
- vcpu:
- type: integer
- format: int64
- description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
- vcpu-units:
+ description: Unique id of site pair set.
+ resource-version:
type: string
- description: units associated with vcpu, used for VNFs with no vservers/flavors
- vmemory:
- type: integer
- format: int64
- description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
- vmemory-units:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ routing-instances:
+ type: array
+ items:
+ $ref: "#/definitions/routing-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
+ required:
+ - snapshot-id
+ properties:
+ snapshot-id:
type: string
- description: units associated with vmemory, used for VNFs with no vservers/flavors
- vdisk:
- type: integer
- format: int64
- description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
- vdisk-units:
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ snapshot-name:
type: string
- description: units associated with vdisk, used for VNFs with no vservers/flavors
- in-maint:
- type: boolean
- is-closed-loop-disabled:
- type: boolean
- resource-version:
+ description: Snapshot name
+ snapshot-architecture:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- summary-status:
+ description: Operating system architecture
+ snapshot-os-distro:
type: string
- description: details regarding the generic-vnf operation
- encrypted-access-flag:
- type: boolean
- description: indicates whether generic-vnf access uses SSH
- persona-model-id:
+ description: The common name of the operating system distribution in lowercase
+ snapshot-os-version:
type: string
- description: the ASDC model id for this resource or service model.
- persona-model-version:
+ description: The operating system version as specified by the distributor.
+ application:
type: string
- description: the ASDC model version for this resource or service model.
- model-version-id:
+ description: The application that the image instantiates.
+ application-vendor:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ description: The vendor of the application.
+ application-version:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: The version of the application.
+ snapshot-selflink:
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:
+ description: URL to endpoint where AAI can get more details
+ prev-snapshot-id:
type: string
- description: as-number of the VNF
- regional-resource-subzone:
+ description: This field contains the UUID of the previous snapshot (if any).
+ resource-version:
type: string
- description: represents sub zone of the rr plane
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
- lag-interfaces:
- type: array
- items:
- $ref: "#/definitions/lag-interface"
- vf-modules:
- type: array
- items:
- $ref: "#/definitions/vf-module"
- generic-vnfs:
+ snapshots:
description: |
- Collection of VNFs
+ Collection of openstack snapshots
properties:
- generic-vnf:
+ snapshot:
type: array
items:
- $ref: "#/definitions/generic-vnf"
- lag-link:
+ $ref: "#/definitions/snapshot"
+ sriov-pf:
description: |
- LAG links can connect lag-interfaces
+ SR-IOV Physical Function
###### Related Nodes
- - FROM lag-interface
- - FROM logical-link
+ - TO p-interface( 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
required:
- - link-name
+ - pf-pci-id
properties:
- link-name:
+ pf-pci-id:
type: string
- description: Alphabetical concatenation of lag-interface names
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- lag-links:
+ sriov-pfs:
description: |
- Collection of link aggregation connections
+ Collection of SR-IOV Physical Functions.
properties:
- lag-link:
+ sriov-pf:
type: array
items:
- $ref: "#/definitions/lag-link"
- newvce:
+ $ref: "#/definitions/sriov-pf"
+ sriov-vf:
description: |
- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ SR-IOV Virtual Function (not to be confused with virtual network function)
###### Related Nodes
- - TO l-interface (comprises newvce, Many2Many)
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
required:
- - vnf-id2
- - vnf-name
- - vnf-type
+ - pci-id
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 and clients should expect changes to occur in the future to this field as ASDC matures.
- prov-status:
+ pci-id:
type: string
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- operational-state:
+ description: PCI ID used to identify the sriov-vf
+ vf-vlan-filter:
type: string
- description: Indicator for whether the resource is considered operational
- license-key:
+ 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: License key
- ipv4-oam-address:
+ 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: 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:
+ 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: Client should send valid enumerated value.
+ 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.
- 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:
+ neutron-network-id:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
+ description: Neutron network id of the interface
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
- newvces:
+ sriov-vfs:
description: |
- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ Collection of SR-IOV Virtual Functions.
properties:
- newvce:
+ sriov-vf:
type: array
items:
- $ref: "#/definitions/newvce"
- pnf:
+ $ref: "#/definitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
description: |
- PNF represents a physical network function. typically equipment used in the D1 world.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- - TO p-interface (comprises pnf, Many2Many)
- - TO lag-interface (comprises pnf, One2Many)
- - TO complex (Many2One)
- - FROM logical-link
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - 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)
+
+ -(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
+
required:
- - pnf-name
- - in-maint
+ - subnet-id
+ - dhcp-enabled
properties:
- pnf-name:
- type: string
- description: unique name of Physical Network Function.
- pnf-name2:
- type: string
- description: name of Physical Network Function.
- pnf-name2-source:
- type: string
- description: source of name2
- pnf-id:
+ subnet-id:
type: string
- description: id of pnf
- equip-type:
+ description: Subnet ID, should be UUID.
+ subnet-name:
type: string
- description: Equipment type. Source of truth should define valid values.
- equip-vendor:
+ description: Name associated with the subnet.
+ neutron-subnet-id:
type: string
- description: Equipment vendor. Source of truth should define valid values.
- equip-model:
+ description: Neutron id of this subnet
+ gateway-address:
type: string
- description: Equipment model. Source of truth should define valid values.
- management-option:
+ description: gateway ip address
+ network-start-address:
type: string
- description: identifier of managed by company or customer
- ipaddress-v4-oam:
+ description: network start address
+ cidr-mask:
type: string
- description: ipv4-oam-address with new naming convention for IP addresses
- sw-version:
+ description: cidr mask
+ ip-version:
type: string
- description: sw-version is the version of SW for the hosted application on the PNF.
+ description: ip version
orchestration-status:
type: string
- description: orchestration-status is the status of orchestration on the PNF.
- in-maint:
+ description: Orchestration status of this VNF, mastered by MSO
+ dhcp-enabled:
type: boolean
- frame-id:
+ description: dhcp enabled
+ dhcp-start:
type: string
- description: ID of the physical frame (relay rack) where pnf is installed.
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
- type: array
- items:
- $ref: "#/definitions/p-interface"
- lag-interfaces:
+ subnets:
+ properties:
+ subnet:
type: array
- items:
- $ref: "#/definitions/lag-interface"
- pnfs:
- description: |
- Collection of Physical Network Functions.
+ items:
+ $ref: "#/definitions/subnet"
+ tagged-inventory-item-list:
properties:
- pnf:
+ inventory-item:
type: array
items:
- $ref: "#/definitions/pnf"
- physical-link:
+ $ref: "#/definitions/inventory-item"
+ tenant:
description: |
- Collection of physical connections, typically between p-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ Openstack tenant
###### Related Nodes
- - FROM p-interface
+ - TO cloud-region( 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 service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
required:
- - link-name
+ - tenant-id
+ - tenant-name
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:
+ tenant-id:
type: string
- description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
- service-provider-name:
+ description: Unique id relative to the cloud-region.
+ tenant-name:
type: string
- description: Name of the service Provider on this link.
+ description: Readable name of tenant
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
+ type: array
+ items:
+ $ref: "#/definitions/vserver"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- physical-links:
+ tenants:
description: |
- Collection of physical connections, typically between p-interfaces
+ Collection of openstack tenants.
properties:
- physical-link:
+ tenant:
type: array
items:
- $ref: "#/definitions/physical-link"
- vig-server:
+ $ref: "#/definitions/tenant"
+ tunnel-xconnect:
description: |
- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
###### Related Nodes
- - FROM ipsec-configuration (is composed of vig-server)
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
required:
- - vig-address-type
+ - id
+ - bandwidth-up-wan1
+ - bandwidth-down-wan1
+ - bandwidth-up-wan2
+ - bandwidth-down-wan2
properties:
- vig-address-type:
+ id:
type: string
- description: indicates whether the VIG is for AVPN or INTERNET
- ipaddress-v4-vig:
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
type: string
- description: v4 IP of the vig server
- ipaddress-v6-vig:
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
type: string
- description: v6 IP of the vig server
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
resource-version:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ description: Concurrency value
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- vig-servers:
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
properties:
- vig-server:
+ tunnel-xconnect:
type: array
items:
- $ref: "#/definitions/vig-server"
- ipsec-configuration:
+ $ref: "#/definitions/tunnel-xconnect"
+ update:
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
- - TO vig-server (comprises ipsec-configuration, One2Many)
- - FROM generic-vnf
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
required:
- - ipsec-configuration-id
+ - update-node-type
properties:
- ipsec-configuration-id:
+ update-node-type:
type: string
- description: UUID of this configuration
- requested-vig-address-type:
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/definitions/update-node-key"
+ update-node-uri:
type: string
- description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
- requested-encryption-strength:
+ action:
+ type: array
+ items:
+ $ref: "#/definitions/action"
+ update-node-key:
+ properties:
+ key-name:
type: string
- description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
- requested-dmz-type:
+ key-value:
type: string
- description: can offer a shared DMZ or a DMZ specific to a customer
- shared-dmz-network-address:
+ 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 port-group( 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
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id:
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:
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-name:
type: string
- description: can be 1 or 2
- ikev1-authentication:
+ description: Name of VNF.
+ vnf-name2:
type: string
- description: Contains values like md5, sha1, sha256, sha384
- ikev1-encryption:
+ description: Alternate name of VNF.
+ vnf-type:
type: string
- description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
- ikev1-dh-group:
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
type: string
- description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
- ikev1-am-group-id:
+ description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
+ regional-resource-zone:
type: string
- description: Group name defined in VIG for clients using aggressive mode
- ikev1-am-password:
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
type: string
- description: pre-shared key for the above group name
- ikev1-sa-lifetime:
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-state:
type: string
- description: Lifetime for IKEv1 SA
- ipsec-authentication:
+ description: Indicator for whether the resource is considered operational
+ license-key:
type: string
- description: md5, sha1, sha256, sha384
- ipsec-encryption:
+ description: License key
+ equipment-role:
type: string
- description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
- ipsec-sa-lifetime:
+ description: Network role being played by this VNF
+ orchestration-status:
type: string
- description: Life time for IPSec SA
- ipsec-pfs:
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
type: string
- description: enable PFS or not
- xauth-userid:
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
type: string
- description: user ID for xAuth, sm-user, ,nmteHostName
- xauth-user-password:
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
type: string
- description: Encrypted using the Juniper $9$ algorithm
- dpd-interval:
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
type: string
- description: The time between DPD probe
- dpd-frequency:
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
type: string
- description: Maximum number of DPD before claiming the tunnel is down
+ 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.
- relationship-list:
+ ipv4-loopback0-address:
+ type: string
+ description: Loopback0 address
+ entitlement-resource-uuid:
+ type: string
+ description: Entitlement resource uuid
+ port-groups:
type: array
items:
- $ref: "#/definitions/relationship"
- vig-servers:
+ $ref: "#/definitions/port-group"
+ relationship-list:
type: array
items:
- $ref: "#/definitions/vig-server"
- ipsec-configurations:
+ $ref: "#/definitions/relationship"
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
properties:
- ipsec-configuration:
+ vce:
type: array
items:
- $ref: "#/definitions/ipsec-configuration"
- route-table-reference:
+ $ref: "#/definitions/vce"
+ vf-module:
description: |
- Openstack route table reference.
+ a deployment unit of VNFCs
###### Related Nodes
- - FROM l3-network
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
required:
- - route-table-reference-id
- - route-table-reference-fqdn
+ - vf-module-id
+ - is-base-vf-module
properties:
- route-table-reference-id:
+ vf-module-id:
type: string
- description: Route Table Reference id, UUID assigned to this instance.
- route-table-reference-fqdn:
+ description: Unique ID of vf-module.
+ vf-module-name:
type: string
- description: FQDN entry in the route table.
+ 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
resource-version:
type: string
- description: Concurrency value
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ contrail-service-instance-fqdn:
+ type: string
+ description: the Contrail unique ID for a service-instance
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- route-table-references:
+ vf-modules:
description: |
- Collection of openstack route table references
+ Collection of vf-modules, a deployment unit of VNFCs
properties:
- route-table-reference:
+ vf-module:
type: array
items:
- $ref: "#/definitions/route-table-reference"
- network:
+ $ref: "#/definitions/vf-module"
+ vig-server:
description: |
- Namespace for network inventory resources.
+ vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ ###### Related Nodes
+ - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
+ required:
+ - vig-address-type
properties:
- logical-links:
- type: array
- items:
- $ref: "#/definitions/logical-link"
- site-pair-sets:
- type: array
- items:
- $ref: "#/definitions/site-pair-set"
- vpn-bindings:
- type: array
- items:
- $ref: "#/definitions/vpn-binding"
- vpls-pes:
- type: array
- items:
- $ref: "#/definitions/vpls-pe"
- multicast-configurations:
- type: array
- items:
- $ref: "#/definitions/multicast-configuration"
- vces:
- type: array
- items:
- $ref: "#/definitions/vce"
- vnfcs:
- type: array
- items:
- $ref: "#/definitions/vnfc"
- l3-networks:
- type: array
- items:
- $ref: "#/definitions/l3-network"
- network-policies:
- type: array
- items:
- $ref: "#/definitions/network-policy"
- generic-vnfs:
- type: array
- items:
- $ref: "#/definitions/generic-vnf"
- lag-links:
- type: array
- items:
- $ref: "#/definitions/lag-link"
- newvces:
- type: array
- items:
- $ref: "#/definitions/newvce"
- pnfs:
- type: array
- items:
- $ref: "#/definitions/pnf"
- physical-links:
- type: array
- items:
- $ref: "#/definitions/physical-link"
- ipsec-configurations:
- type: array
- items:
- $ref: "#/definitions/ipsec-configuration"
- route-table-references:
+ 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: "#/definitions/route-table-reference"
- inventory:
- properties:
- search:
- type: object
- $ref: "#/definitions/search"
- actions:
- type: object
- $ref: "#/definitions/actions"
- cloud-infrastructure:
- type: object
- $ref: "#/definitions/cloud-infrastructure"
- business:
- type: object
- $ref: "#/definitions/business"
- service-design-and-creation:
- type: object
- $ref: "#/definitions/service-design-and-creation"
- network:
- type: object
- $ref: "#/definitions/network"
- aai-internal:
- type: object
- $ref: "#/definitions/aai-internal"
- edge-tag-query-result:
- properties:
- tagged-inventory-item-list:
- type: array
- items:
- $ref: "#/definitions/tagged-inventory-item-list"
- tagged-inventory-item-list:
+ $ref: "#/definitions/relationship"
+ vig-servers:
properties:
- inventory-item:
+ vig-server:
type: array
items:
- $ref: "#/definitions/inventory-item"
- inventory-item:
+ $ref: "#/definitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv4-address
properties:
- inventory-item-type:
+ vip-ipv4-address:
type: string
- inventory-item-link:
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
type: string
- inventory-item-data:
- type: array
- items:
- $ref: "#/definitions/inventory-item-data"
- tagged-inventory-item-list:
+ 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: "#/definitions/tagged-inventory-item-list"
- inventory-item-data:
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv6-address
properties:
- property-name:
+ vip-ipv6-address:
type: string
- property-value:
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
type: string
- edge-tag-query-request:
+ 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: "#/definitions/relationship"
+ 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)
+
+ required:
+ - vdc-id
+ - vdc-name
properties:
- edge-tag:
+ vdc-id:
type: string
- result-detail:
+ description: Unique ID of the vdc
+ vdc-name:
type: string
- start-node-type:
+ description: Name of the virtual data center
+ resource-version:
type: string
- start-node-filter:
- type: array
- items:
- $ref: "#/definitions/start-node-filter"
- include-node-filter:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
type: array
- items:
- $ref: "#/definitions/include-node-filter"
- secondary-filter:
+ items:
+ $ref: "#/definitions/relationship"
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
type: array
items:
- $ref: "#/definitions/secondary-filter"
- start-node-filter:
+ $ref: "#/definitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(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
+ required:
+ - vlan-interface
properties:
- property-name:
- type: string
- property-value:
+ vlan-interface:
type: string
- include-node-filter:
- properties:
- include-node-type:
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ resource-version:
type: string
- secondary-filter:
- properties:
- property-name:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
type: string
- filter-type:
+ description: Captures the numeric part of the speed
+ speed-units:
type: string
- property-value:
+ description: Captures the units corresponding to the speed
+ vlan-description:
type: string
- search-results:
- properties:
- result-data:
- type: array
- items:
- $ref: "#/definitions/result-data"
- result-data:
- properties:
- resource-type:
+ description: Used to describe (the service associated with) the vlan
+ backdoor-connection:
type: string
- description: The specific type of node in the A&AI graph
- resource-link:
+ description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
+ vpn-id:
type: string
- description: The URL to the specific resource
- sdn-zone-response:
- properties:
- oam-networks:
- type: object
- $ref: "#/definitions/oam-networks"
- az-and-dvs-switches:
+ description: This indicates the customers VPN ID associated with this vlan
+ relationship-list:
type: array
- items:
- $ref: "#/definitions/az-and-dvs-switches"
- az-and-dvs-switches:
- properties:
- dvs-switches:
- type: object
- $ref: "#/definitions/dvs-switches"
- availability-zone:
- type: object
- $ref: "#/definitions/availability-zone"
- update:
- description: |
- Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
- required:
- - update-node-type
- properties:
- update-node-type:
- type: string
- update-node-key:
+ items:
+ $ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
type: array
items:
- $ref: "#/definitions/update-node-key"
- update-node-uri:
- type: string
- action:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
type: array
items:
- $ref: "#/definitions/action"
- action:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ vlans:
properties:
- action-type:
- type: string
- action-data:
+ vlan:
type: array
items:
- $ref: "#/definitions/action-data"
- action-data:
- properties:
- property-name:
- type: string
- property-value:
- type: string
- update-node-key:
+ $ref: "#/definitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
properties:
- key-name:
- type: string
- key-value:
+ vnf-id:
type: string
- notify:
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ 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
+
required:
- - event-id
+ - vnf-image-uuid
+ - application
+ - application-vendor
properties:
- event-id:
+ vnf-image-uuid:
type: string
- node-type:
+ description: Unique ID of this asset
+ application:
type: string
- event-trigger:
+ description: The application that the image instantiates.
+ application-vendor:
type: string
- key-data:
- type: array
- items:
- $ref: "#/definitions/key-data"
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
selflink:
type: string
- key-data:
- properties:
- key-name:
- type: string
- key-value:
+ description: URL to endpoint where AAI can get more details
+ resource-version:
type: string
- notification-event:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
properties:
- cambria.partition:
- type: string
- notification-event-header:
- type: object
- $ref: "#/definitions/notification-event-header"
- notification-event-header:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/definitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
+ required:
+ - vnfc-name
+ - vnfc-function-code
+ - vnfc-type
+ - in-maint
+ - is-closed-loop-disabled
properties:
- id:
+ vnfc-name:
type: string
- timestamp:
+ description: Unique ID of vnfc.
+ vnfc-function-code:
type: string
- source-name:
+ description: function code
+ vnfc-type:
type: string
- domain:
+ description: type
+ prov-status:
type: string
- sequence-number:
+ description: prov status of this vnfc
+ orchestration-status:
type: string
- severity:
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
type: string
- event-type:
+ 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
- version:
+ description: Group notation of VNFC
+ resource-version:
type: string
- action:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/definitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
+ required:
+ - volume-id
+ - volume-selflink
+ properties:
+ volume-id:
type: string
- entity-type:
+ description: Unique ID of block storage volume relative to the vserver.
+ volume-selflink:
type: string
- top-entity-type:
+ description: URL to endpoint where AAI can get more details
+ resource-version:
type: string
- entity-link:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ properties:
+ volume-group-id:
type: string
- status:
+ description: Unique ID of volume-group.
+ volume-group-name:
type: string
- reserved-prop-names:
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this 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: "#/definitions/relationship"
+ volume-groups:
description: |
- Internal map to define some reserved properties of a vertex
+ Collection of persistent block-level storage.
properties:
- last-mod-source-of-truth:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/definitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/definitions/volume"
+ vpls-pe:
+ 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( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
+ required:
+ - equipment-name
+ properties:
+ equipment-name:
type: string
- aai-node-type:
+ prov-status:
type: string
- aai-created-ts:
- type: integer
- format: int64
- aai-unique-key:
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ ipv4-oam-address:
type: string
- aai-last-mod-ts:
+ 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
format: int64
- source-of-truth:
+ description: Temporary location for stag to get to VCE
+ resource-version:
type: string
- edge-prop-names:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ vpls-pes:
description: |
- Internal map to define the properties of an edge and interpret the map EdgeRules
+ Collection of VPLS Provider Edge routers
properties:
- edgeLabel:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/definitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+
+ -VPN-BINDING cannot be deleted if related to L3-NETWORK
+
+ required:
+ - vpn-id
+ - vpn-name
+ - global-route-target
+ properties:
+ vpn-id:
type: string
- direction:
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
type: string
- multiplicityRule:
+ description: VPN Name
+ global-route-target:
type: string
- isParent:
- type: boolean
- usesResource:
- type: boolean
- hasDelTarget:
- type: boolean
- SVC-INFRA:
+ description: Number used to identify a VPN, globally unique in the network
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ 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: "#/definitions/relationship"
+ description: l3-networks relate to vpn-bindings
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/definitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - 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 volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - 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
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ 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
- SVC-INFRA-REV:
+ 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
- model-and-named-query-search:
+ 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: "#/definitions/volume"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ vservers:
description: |
- ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ Collection of virtual Servers, aka virtual machines or VMs.
properties:
- query-parameters:
- type: object
- $ref: "#/definitions/query-parameters"
- instance-filters:
- type: object
- $ref: "#/definitions/instance-filters"
- top-node-type:
- type: string
- query-parameters:
+ vserver:
+ type: array
+ items:
+ $ref: "#/definitions/vserver"
+ zone:
description: |
- QueryParameters for performing a named-query or model query
+ 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)
+
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
properties:
- named-query:
- type: object
- $ref: "#/definitions/named-query"
- model:
- type: object
- $ref: "#/definitions/model"
- instance-filters:
+ 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
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ zones:
description: |
- InstanceFilters for performing a named-query or model query
+ Collection of zones
properties:
- instance-filter:
+ zone:
type: array
items:
- $ref: "#/definitions/instance-filter"
- instance-filter:
- description: |
- InstanceFilter for performing a named-query or model query
- properties:
- description: |
- Property holder for query properties or instance properties
+ $ref: "#/definitions/zone"
+patchDefinitions:
+ action:
+ properties:
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/action-data"
+ action-data:
properties:
property-name:
type: string
property-value:
type: string
- response-list:
+ actions:
description: |
- Response container for the results of a named-query or model query
+ APIs that are more action related than REST (e.g., notify, update).
properties:
- inventory-response-items:
+ update:
type: object
- $ref: "#/definitions/inventory-response-items"
- inventory-response-items:
+ $ref: "#/patchDefinitions/update"
+ notify:
+ type: object
+ $ref: "#/patchDefinitions/notify"
+ allotted-resource:
description: |
- Container for inventory items in response list
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
+ required:
+ - id
properties:
- inventory-response-item:
+ 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
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
type: array
items:
- $ref: "#/definitions/inventory-response-item"
- inventory-response-item:
+ $ref: "#/patchDefinitions/allotted-resource"
+ availability-zone:
description: |
- Inventory item for response list
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - 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
+
+ required:
+ - availability-zone-name
+ - hypervisor-type
properties:
- model-name:
+ availability-zone-name:
type: string
- extra-properties:
+ 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-state:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
type: object
- $ref: "#/definitions/extra-properties"
- inventory-response-items:
+ $ref: "#/patchDefinitions/dvs-switches"
+ availability-zone:
type: object
- $ref: "#/definitions/inventory-response-items"
- extra-properties:
+ $ref: "#/patchDefinitions/availability-zone"
+ business:
description: |
- Extra properties for inventory item for response list
- extra-property:
+ Namespace for business related constructs
properties:
- property-name:
+ connectors:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/customer"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
+ required:
+ - cos
+ properties:
+ cos:
type: string
- vnf:
+ description: unique identifier of probe
+ probe-id:
+ type: string
+ description: identifier of probe
+ probe-type:
+ type: string
+ description: type of probe
+ classes-of-service:
description: |
- Abstract vnf class
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/virtual-data-center"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
+ ###### Related Nodes
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver LocatedIn 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,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
+
required:
- - vnf-id
+ - cloud-owner
+ - cloud-region-id
properties:
- vnf-id:
+ cloud-owner:
type: string
- description: Unique id of VNF. This is unique across the graph.
+ 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
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance
+ cloud-regions:
+ properties:
+ cloud-region:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cloud-region"
+ complex:
+ 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( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
+
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ 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
+ complexes:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ properties:
+ complex:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+
+ -(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
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ 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
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/configuration"
+ connector:
+ 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( 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
+ required:
+ - resource-instance-id
+ properties:
+ resource-instance-id:
+ type: string
+ description: Unique id of resource instance.
+ connectors:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ properties:
+ connector:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/connector"
+ constrained-element-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-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
+ required:
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
+ properties:
+ constrained-element-set-uuid:
+ type: string
+ constraint-type:
+ type: string
+ check-type:
+ type: string
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ ctag-assignment:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: id.
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ctag-assignment"
+ ctag-pool:
+ description: |
+ A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ 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
+ ctag-pools:
+ properties:
+ ctag-pool:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ctag-pool"
+ customer:
+ description: |
+ customer identifiers to provide linkage back to BSS information.
+ ###### Related Nodes
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
+ required:
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
+ properties:
+ global-customer-id:
+ type: string
+ description: Global customer id used across ECOMP 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.
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
+ type: string
+ description: DVS switch name
+ vcenter-url:
+ type: string
+ description: URL used to reach the vcenter
+ dvs-switches:
+ description: |
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
+ properties:
+ dvs-switch:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/dvs-switch"
+ edge-prop-names:
+ description: |
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ isParent:
+ type: boolean
+ usesResource:
+ type: boolean
+ hasDelTarget:
+ type: boolean
+ SVC-INFRA:
+ type: boolean
+ SVC-INFRA-REV:
+ type: boolean
+ edge-tag-query-request:
+ properties:
+ edge-tag:
+ type: string
+ result-detail:
+ type: string
+ start-node-type:
+ type: string
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( 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
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ properties:
+ element-choice-set-uuid:
+ type: string
+ element-choice-set-name:
+ type: string
+ cardinality:
+ type: string
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
+ required:
+ - group-uuid
+ - resource-uuid
+ 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.
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
+ required:
+ - ems-id
+ properties:
+ ems-id:
+ type: string
+ description: Unique ID of EMS.
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-ems"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ 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.
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-system-info"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
+ required:
+ - thirdparty-sdnc-id
+ 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.
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
+ required:
+ - vnfm-id
+ 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.
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
+ required:
+ - evc-id
+ 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
+ evcs:
+ properties:
+ evc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to VSERVER
+
+ required:
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
+ properties:
+ flavor-id:
+ type: string
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
+ type: string
+ description: Flavor name
+ flavor-vcpus:
+ type: integer
+ format: int32
+ description: Number of CPUs
+ flavor-ram:
+ type: integer
+ format: int32
+ description: Amount of memory
+ flavor-disk:
+ type: integer
+ format: int32
+ description: Disk space
+ flavor-ephemeral:
+ type: integer
+ format: int32
+ description: Amount of ephemeral disk space
+ 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
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(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
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
+ type: string
+ description: ingress, intermediate, egress
+ forwarder-evc:
+ description: |
+ forwarder object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
+ required:
+ - forwarder-evc-id
+ 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.
+ forwarder-evcs:
+ properties:
+ forwarder-evc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarder"
+ forwarding-path:
+ description: |
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( 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
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
+ properties:
+ forwarding-path-id:
+ type: string
+ description: Unique ID of this FP
+ forwarding-path-name:
+ type: string
+ description: Name of the FP
+ forwarding-paths:
+ properties:
+ forwarding-path:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarding-path"
+ generic-vnf:
+ description: |
+ General purpose VNF
+ ###### Related Nodes
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, 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)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo 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( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ - in-maint
+ - is-closed-loop-disabled
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC
+ 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-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used 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
+ management-option:
+ type: string
+ description: identifier of managed by company or 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
+ format: int64
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors
+ 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
+ generic-vnfs:
+ description: |
+ Collection of VNFs
+ properties:
+ generic-vnf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/generic-vnf"
+ group-assignment:
+ description: |
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
+ required:
+ - group-id
+ - group-type
+ - group-name
+ 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
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
+ properties:
+ group-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/group-assignment"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ 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
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/host-route"
+ hpa-capabilities:
+ description: |
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
+ ###### Related Nodes
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
+ required:
+ - hpa-capability-id
+ - hpa-feature
+ 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
+ hpa-feature-attributes:
+ description: |
+ HPA Capability Feature attributes
+ ###### Related Nodes
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
+ required:
+ - hpa-attribute-key
+ 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
+ image:
+ description: |
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( 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
+
+ required:
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
+ 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
+ images:
+ description: |
+ Collectio of Openstack images.
+ properties:
+ image:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
+ description: |
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
+ description: |
+ InstanceFilters for performing a named-query or model query
+ properties:
+ instance-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
+ ###### Related Nodes
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+
+ required:
+ - id
+ - description
+ - type
+ properties:
+ id:
+ type: string
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
+ type: string
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
+ type: string
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
+ type: string
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ instance-groups:
+ description: |
+ Collection of openstack route table references
+ properties:
+ instance-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-group"
+ inventory:
+ properties:
+ search:
+ type: object
+ $ref: "#/patchDefinitions/search"
+ actions:
+ type: object
+ $ref: "#/patchDefinitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/patchDefinitions/cloud-infrastructure"
+ business:
+ type: object
+ $ref: "#/patchDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/patchDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/patchDefinitions/network"
+ inventory-item:
+ properties:
+ inventory-item-type:
+ type: string
+ inventory-item-link:
+ type: string
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
+ type: string
+ extra-properties:
+ type: object
+ $ref: "#/patchDefinitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/patchDefinitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-response-item"
+ ipsec-configuration:
+ 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( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
+ required:
+ - ipsec-configuration-id
+ 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: can offer a 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, ,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
+ ipsec-configurations:
+ properties:
+ ipsec-configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
+ description: |
+ Logical interfaces, e.g., a vnic.
+ ###### Related Nodes
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
+ required:
+ - interface-name
+ 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
+ l-interfaces:
+ description: |
+ Collection of logical interfaces.
+ properties:
+ l-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l-interface"
+ l3-interface-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
+ required:
+ - l3-interface-ipv4-address
+ properties:
+ l3-interface-ipv4-address:
+ type: string
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ l3-interface-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
+ required:
+ - l3-interface-ipv6-address
+ properties:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ l3-network:
+ description: |
+ Generic network definition
+ ###### Related Nodes
+ - 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 cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - 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 ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
+ required:
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
+ 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
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
+ l3-networks:
+ properties:
+ l3-network:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l3-network"
+ lag-interface:
+ description: |
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-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
+ required:
+ - interface-name
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ lag-interfaces:
+ description: |
+ Collection of link aggregate interfaces.
+ properties:
+ lag-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-interface"
+ lag-link:
+ 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
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: Alphabetical concatenation of lag-interface names
+ lag-links:
+ description: |
+ Collection of link aggregation connections
+ properties:
+ lag-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-link"
+ license:
+ description: |
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
+ required:
+ - group-uuid
+ - resource-uuid
+ 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.
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ license:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/license"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, ONE2MANY)
+ - 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)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ required:
+ - link-name
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ 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
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+ - TO model( metadatum BelongsTo model, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
+ required:
+ - metaname
+ - metaval
+ properties:
+ metaname:
+ type: string
+ metaval:
+ type: string
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-element isA model, MANY2ONE)
+ - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+ - FROM model-element( model-element isA model, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -(2) IF this MODEL node is deleted, this TO node is DELETED also
+ -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
+
+ required:
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ 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
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/patchDefinitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/patchDefinitions/instance-filters"
+ top-node-type:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( 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
+ required:
+ - model-constraint-uuid
+ - constrained-element-set-uuid-to-replace
+ properties:
+ model-constraint-uuid:
+ type: string
+ constrained-element-set-uuid-to-replace:
+ type: string
+ constrained-element-sets:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ model-constraints:
+ properties:
+ model-constraint:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-constraint"
+ model-element:
+ description: |
+ Defines how other models combine to make up a higher-level model.
+ ###### Related Nodes
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model( model-element isA model, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model (PARENT of model-element, model startsWith model-element)(3)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
+ required:
+ - model-element-uuid
+ - new-data-del-flag
+ - cardinality
+ 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
+ model-elements:
+ properties:
+ model-element:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-element"
+ model-ver:
+ 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( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM metadatum( metadatum 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
+
+ required:
+ - model-version-id
+ - model-name
+ - model-version
+ 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
+ model-description:
+ type: string
+ description: Description
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-ver"
+ models:
+ description: |
+ Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
+ properties:
+ model:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model"
+ multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
+ required:
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
+ 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
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
+ properties:
+ multicast-configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query"
+ named-query:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
+ required:
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
+ properties:
+ named-query-uuid:
+ type: string
+ named-query-name:
+ type: string
+ named-query-version:
+ type: string
+ required-input-param:
+ type: string
+ description:
+ type: string
+ named-query-element:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(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
+ required:
+ - named-query-element-uuid
+ properties:
+ named-query-element-uuid:
+ type: string
+ property-collect-list:
+ type: string
+ named-query-elements:
+ properties:
+ named-query-element:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query-element"
+ network:
+ description: |
+ Namespace for network inventory resources.
+ properties:
+ logical-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/logical-link"
+ site-pair-sets:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair-set"
+ vpn-bindings:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpn-binding"
+ vpls-pes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpls-pe"
+ multicast-configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/multicast-configuration"
+ vces:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vce"
+ vnfcs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnfc"
+ l3-networks:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-table-reference"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
+ required:
+ - network-policy-id
+ 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
+ network-profile:
+ description: |
+ Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
+ required:
+ - nm-profile-name
+ properties:
+ nm-profile-name:
+ type: string
+ description: Unique name of network profile.
+ community-string:
+ type: string
+ description: Encrypted SNMP community string
+ network-profiles:
+ description: |
+ Collection of network profiles
+ properties:
+ network-profile:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-profile"
+ newvce:
+ 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( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
+ required:
+ - vnf-id2
+ - vnf-name
+ - vnf-type
+ 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 and clients should expect changes to occur in the future to this field as ASDC matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ 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.
+ newvces:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ properties:
+ newvce:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/newvce"
+ nodes:
+ properties:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item-data"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/patchDefinitions/notification-event-header"
+ notification-event-header:
+ 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:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ 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
+ format: int64
+ description: cvlan-id
+ 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
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ oam-networks:
+ description: |
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
+ properties:
+ oam-network:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/oam-network"
+ operational-environment:
+ 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, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
+ required:
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
+ 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.
+ operational-environments:
+ description: |
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ properties:
+ operational-environment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/operational-environment"
+ overloaded-model:
+ description: |
+ Allows for legacy POST of old-style and new-style models
+ required:
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ 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
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/owning-entity"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+
+ -(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
+ required:
+ - interface-name
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the physical interface
+ 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.
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/p-interface"
+ physical-link:
+ 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
+ required:
+ - link-name
+ 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.
+ physical-links:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ properties:
+ physical-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/platform"
+ pnf:
+ description: |
+ PNF represents a physical network function. typically equipment used in the D1 world.
+ ###### Related Nodes
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
+ required:
+ - pnf-name
+ - in-maint
+ properties:
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ 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 by company or customer
+ 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.
+ orchestration-status:
+ type: string
+ description: orchestration-status is the status of orchestration 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.
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pnf"
+ port-group:
+ description: |
+ Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( 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
+ required:
+ - interface-id
+ - orchestration-status
+ 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.
+ port-groups:
+ properties:
+ port-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/port-group"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/project"
+ properties:
+ description: |
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
+ type: string
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraints:
+ properties:
+ property-constraint:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/property-constraint"
+ pserver:
+ description: |
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ ###### Related Nodes
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( 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 GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
+ required:
+ - hostname
+ - in-maint
+ 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
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ 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
+ 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.
+ pservers:
+ description: |
+ Collection of compute hosts.
+ properties:
+ pserver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/patchDefinitions/named-query"
+ model:
+ type: object
+ $ref: "#/patchDefinitions/model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
+ required:
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
+ 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
+ related-lookups:
+ properties:
+ related-lookup:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/related-lookup"
+ related-to-property:
+ 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:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/relationship-data"
+ related-to-property:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/related-to-property"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ 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.
+ reserved-prop-names:
+ description: |
+ Internal map to define some reserved properties of a vertex
+ 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
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/patchDefinitions/inventory-response-items"
+ result-data:
+ 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:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ 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.
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
+ required:
+ - global-route-target
+ - route-target-role
+ 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
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( 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
+ required:
+ - routing-instance-id
+ properties:
+ routing-instance-id:
+ type: string
+ description: Unique id of routing instance
+ rpm-owner:
+ type: string
+ description: rpm owner
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/patchDefinitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/patchDefinitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/patchDefinitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/patchDefinitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/patchDefinitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
+ type: string
+ filter-type:
+ type: string
+ property-value:
+ type: string
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
+ required:
+ - segmentation-id
+ properties:
+ segmentation-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
+ required:
+ - service-id
+ - service-description
+ 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
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-capability"
+ service-capability:
+ 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
+
+ required:
+ - service-type
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query"
+ service-instance:
+ description: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(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
+ required:
+ - service-instance-id
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ 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.
+ service-instances:
+ description: |
+ Collection of service instances
+ properties:
+ service-instance:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-instance"
+ service-subscription:
+ description: |
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( 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
+ required:
+ - service-type
+ properties:
+ service-type:
+ type: string
+ description: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
+ type: string
+ description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( 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
+ required:
+ - site-pair-id
+ 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, etc.
+ 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( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
+ type: string
+ description: Unique id of site pair set.
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
+ required:
+ - snapshot-id
+ 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).
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( 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
+ required:
+ - pf-pci-id
+ properties:
+ pf-pci-id:
+ type: string
+ description: Identifier for the sriov-pf
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
+ required:
+ - pci-id
+ 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.
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - 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)
+
+ -(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
+
+ required:
+ - subnet-id
+ - dhcp-enabled
+ 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
+ subnets:
+ properties:
+ subnet:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( 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 service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
+ required:
+ - tenant-id
+ - tenant-name
+ properties:
+ tenant-id:
+ type: string
+ description: Unique id relative to the cloud-region.
+ tenant-name:
+ type: string
+ description: Readable name of tenant
+ tenants:
+ description: |
+ Collection of openstack tenants.
+ properties:
+ tenant:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tenant"
+ tunnel-xconnect:
+ description: |
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
+ required:
+ - id
+ - bandwidth-up-wan1
+ - bandwidth-down-wan1
+ - bandwidth-up-wan2
+ - bandwidth-down-wan2
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
+ type: string
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
+ type: string
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ properties:
+ tunnel-xconnect:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tunnel-xconnect"
+ update:
+ description: |
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
+ required:
+ - update-node-type
+ properties:
+ update-node-type:
+ type: string
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/action"
+ update-node-key:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ 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 port-group( 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
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
+ 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-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ 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.
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ properties:
+ vce:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vce"
+ vf-module:
+ description: |
+ a deployment unit of VNFCs
+ ###### Related Nodes
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
+ required:
+ - vf-module-id
+ - is-base-vf-module
+ 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
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vf-module"
+ 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( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
+ required:
+ - vig-address-type
+ 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
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ 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)
+
+ required:
+ - vdc-id
+ - vdc-name
+ properties:
+ vdc-id:
+ type: string
+ description: Unique ID of the vdc
+ vdc-name:
+ type: string
+ description: Name of the virtual data center
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(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
+ required:
+ - vlan-interface
+ properties:
+ vlan-interface:
+ type: string
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ vlans:
+ properties:
+ vlan:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ 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
+
+ required:
+ - vnf-image-uuid
+ - application
+ - application-vendor
+ 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
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ properties:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
+ required:
+ - vnfc-name
+ - vnfc-function-code
+ - vnfc-type
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ vnfc-function-code:
+ type: string
+ description: function code
+ vnfc-type:
+ type: string
+ description: type
+ 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
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
+ required:
+ - volume-id
+ - volume-selflink
+ 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
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ volume-groups:
+ description: |
+ Collection of persistent block-level storage.
+ properties:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/volume"
+ vpls-pe:
+ 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( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
+ required:
+ - equipment-name
+ 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
+ format: int64
+ description: Temporary location for stag to get to VCE
+ vpls-pes:
+ description: |
+ Collection of VPLS Provider Edge routers
+ properties:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+
+ -VPN-BINDING cannot be deleted if related to L3-NETWORK
+
+ required:
+ - vpn-id
+ - vpn-name
+ - global-route-target
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ global-route-target:
+ type: string
+ description: Number used to identify a VPN, globally unique in the network
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - 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 volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - 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
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ 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
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
+ properties:
+ vserver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vserver"
+ 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)
+
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
+ 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.
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/zone"
+getDefinitions:
+ action:
+ properties:
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/action-data"
+ action-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
+ properties:
+ update:
+ type: object
+ $ref: "#/getDefinitions/update"
+ notify:
+ type: object
+ $ref: "#/getDefinitions/notify"
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
+ required:
+ - id
+ 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
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-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: Concurrency value
+ tunnel-xconnects:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tunnel-xconnect"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
+ type: array
+ items:
+ $ref: "#/getDefinitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - 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
+
+ required:
+ - availability-zone-name
+ - hypervisor-type
+ 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-state:
+ 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: "#/getDefinitions/relationship"
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
+ type: array
+ items:
+ $ref: "#/getDefinitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
+ type: object
+ $ref: "#/getDefinitions/dvs-switches"
+ availability-zone:
+ type: object
+ $ref: "#/getDefinitions/availability-zone"
+ business:
+ description: |
+ Namespace for business related constructs
+ properties:
+ connectors:
+ type: array
+ items:
+ $ref: "#/getDefinitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/customer"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
+ required:
+ - cos
+ 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: "#/getDefinitions/relationship"
+ classes-of-service:
+ description: |
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/getDefinitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/virtual-data-center"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
+ ###### Related Nodes
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver LocatedIn 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,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
+
+ required:
+ - cloud-owner
+ - cloud-region-id
+ 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
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance
+ 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: "#/getDefinitions/volume-group"
+ tenants:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tenant"
+ flavors:
+ type: array
+ items:
+ $ref: "#/getDefinitions/flavor"
+ group-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/group-assignment"
+ snapshots:
+ type: array
+ items:
+ $ref: "#/getDefinitions/snapshot"
+ images:
+ type: array
+ items:
+ $ref: "#/getDefinitions/image"
+ dvs-switches:
+ type: array
+ items:
+ $ref: "#/getDefinitions/dvs-switch"
+ oam-networks:
+ type: array
+ items:
+ $ref: "#/getDefinitions/oam-network"
+ availability-zones:
+ type: array
+ items:
+ $ref: "#/getDefinitions/availability-zone"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ cloud-regions:
+ properties:
+ cloud-region:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cloud-region"
+ complex:
+ 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( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
+
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ 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: "#/getDefinitions/ctag-pool"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ complexes:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ properties:
+ complex:
+ type: array
+ items:
+ $ref: "#/getDefinitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+
+ -(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
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ 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
+ 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: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/configuration"
+ connector:
+ 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( 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
+ required:
+ - resource-instance-id
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ connectors:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ properties:
+ connector:
+ type: array
+ items:
+ $ref: "#/getDefinitions/connector"
+ constrained-element-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-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
+ required:
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
+ 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: "#/getDefinitions/element-choice-set"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/constrained-element-set"
+ ctag-assignment:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: id.
+ 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: "#/getDefinitions/relationship"
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-assignment"
+ ctag-pool:
+ description: |
+ A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ 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: "#/getDefinitions/relationship"
+ ctag-pools:
+ properties:
+ ctag-pool:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-pool"
+ customer:
+ description: |
+ customer identifiers to provide linkage back to BSS information.
+ ###### Related Nodes
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
+ required:
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
+ properties:
+ global-customer-id:
+ type: string
+ description: Global customer id used across ECOMP 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: "#/getDefinitions/service-subscription"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/getDefinitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
+ 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: "#/getDefinitions/relationship"
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
+ required:
+ - switch-name
+ - vcenter-url
+ 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: "#/getDefinitions/relationship"
+ dvs-switches:
+ description: |
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
+ properties:
+ dvs-switch:
+ type: array
+ items:
+ $ref: "#/getDefinitions/dvs-switch"
+ edge-prop-names:
+ description: |
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ isParent:
+ type: boolean
+ usesResource:
+ type: boolean
+ hasDelTarget:
+ type: boolean
+ SVC-INFRA:
+ type: boolean
+ SVC-INFRA-REV:
+ type: boolean
+ edge-tag-query-request:
+ properties:
+ edge-tag:
+ type: string
+ result-detail:
+ type: string
+ start-node-type:
+ type: string
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( 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
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ 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: "#/getDefinitions/model-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
+ required:
+ - group-uuid
+ - resource-uuid
+ 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: "#/getDefinitions/relationship"
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
+ required:
+ - ems-id
+ 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: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-ems"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ 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.
+ 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: "#/getDefinitions/relationship"
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-system-info"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
+ required:
+ - thirdparty-sdnc-id
+ 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: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-thirdparty-sdnc"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
+ required:
+ - vnfm-id
+ 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: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
+ required:
+ - evc-id
+ 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
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ evcs:
+ properties:
+ evc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/getDefinitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/getDefinitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to VSERVER
+
+ required:
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
+ properties:
+ flavor-id:
+ type: string
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
+ type: string
+ description: Flavor name
+ flavor-vcpus:
+ type: integer
+ format: int32
+ description: Number of CPUs
+ flavor-ram:
+ type: integer
+ format: int32
+ description: Amount of memory
+ flavor-disk:
+ type: integer
+ format: int32
+ description: Disk space
+ flavor-ephemeral:
+ type: integer
+ format: int32
+ description: Amount of ephemeral disk space
+ 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
+ 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: "#/getDefinitions/relationship"
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/getDefinitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(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
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
+ type: string
+ description: ingress, intermediate, egress
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evc:
+ description: |
+ forwarder object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
+ required:
+ - forwarder-evc-id
+ 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.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evcs:
+ properties:
+ forwarder-evc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder"
+ forwarding-path:
+ description: |
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( 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
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
+ 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: "#/getDefinitions/relationship"
+ 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: "#/getDefinitions/forwarder"
+ forwarding-paths:
+ properties:
+ forwarding-path:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarding-path"
+ generic-vnf:
+ description: |
+ General purpose VNF
+ ###### Related Nodes
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, 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)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo 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( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ - in-maint
+ - is-closed-loop-disabled
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC
+ 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-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used 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
+ management-option:
+ type: string
+ description: identifier of managed by company or 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
+ format: int64
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors
+ 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
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ vf-modules:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vf-module"
+ generic-vnfs:
+ description: |
+ Collection of VNFs
+ properties:
+ generic-vnf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/generic-vnf"
+ group-assignment:
+ description: |
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
+ required:
+ - group-id
+ - group-type
+ - group-name
+ 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: "#/getDefinitions/relationship"
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
+ properties:
+ group-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/group-assignment"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ 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: "#/getDefinitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/getDefinitions/host-route"
+ hpa-capabilities:
+ description: |
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
+ ###### Related Nodes
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
+ required:
+ - hpa-capability-id
+ - hpa-feature
+ 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: "#/getDefinitions/relationship"
+ hpa-feature-attributes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-feature-attributes"
+ hpa-feature-attributes:
+ description: |
+ HPA Capability Feature attributes
+ ###### Related Nodes
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
+ required:
+ - hpa-attribute-key
+ 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: "#/getDefinitions/relationship"
+ image:
+ description: |
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( 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
+
+ required:
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
+ 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: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ images:
+ description: |
+ Collectio of Openstack images.
+ properties:
+ image:
+ type: array
+ items:
+ $ref: "#/getDefinitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
+ description: |
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
+ description: |
+ InstanceFilters for performing a named-query or model query
+ properties:
+ instance-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
+ ###### Related Nodes
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+
+ required:
+ - id
+ - description
+ - type
+ properties:
+ id:
+ type: string
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
+ type: string
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
+ type: string
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
+ type: string
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ instance-groups:
+ description: |
+ Collection of openstack route table references
+ properties:
+ instance-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-group"
+ inventory:
+ properties:
+ search:
+ type: object
+ $ref: "#/getDefinitions/search"
+ actions:
+ type: object
+ $ref: "#/getDefinitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/getDefinitions/cloud-infrastructure"
+ business:
+ type: object
+ $ref: "#/getDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/getDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/getDefinitions/network"
+ inventory-item:
+ properties:
+ inventory-item-type:
+ type: string
+ inventory-item-link:
+ type: string
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
+ type: string
+ extra-properties:
+ type: object
+ $ref: "#/getDefinitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/getDefinitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-response-item"
+ ipsec-configuration:
+ 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( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
+ required:
+ - ipsec-configuration-id
+ 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: can offer a 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, ,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: "#/getDefinitions/relationship"
+ vig-servers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vig-server"
+ ipsec-configurations:
+ properties:
+ ipsec-configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
+ description: |
+ Logical interfaces, e.g., a vnic.
+ ###### Related Nodes
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
+ required:
+ - interface-name
+ 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
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vlans:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-vf"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ l-interfaces:
+ description: |
+ Collection of logical interfaces.
+ properties:
+ l-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ l3-interface-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
+ required:
+ - l3-interface-ipv4-address
+ properties:
+ l3-interface-ipv4-address:
+ type: string
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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: "#/getDefinitions/relationship"
+ l3-interface-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
+ required:
+ - l3-interface-ipv6-address
+ properties:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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: "#/getDefinitions/relationship"
+ l3-network:
+ description: |
+ Generic network definition
+ ###### Related Nodes
+ - 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 cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - 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 ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
+ required:
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
+ 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
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
+ 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
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ 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.
+ subnets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/subnet"
+ ctag-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-assignment"
+ segmentation-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/segmentation-assignment"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
+ l3-networks:
+ properties:
+ l3-network:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-network"
+ lag-interface:
+ description: |
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-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
+ required:
+ - interface-name
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate 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
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ lag-interfaces:
+ description: |
+ Collection of link aggregate interfaces.
+ properties:
+ lag-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ lag-link:
+ 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
+ required:
+ - link-name
+ 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: "#/getDefinitions/relationship"
+ lag-links:
+ description: |
+ Collection of link aggregation connections
+ properties:
+ lag-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-link"
+ license:
+ description: |
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
+ required:
+ - group-uuid
+ - resource-uuid
+ 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: "#/getDefinitions/relationship"
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ license:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
+ required:
+ - line-of-business-name
+ 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: "#/getDefinitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/getDefinitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, ONE2MANY)
+ - 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)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ required:
+ - link-name
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ 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.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+ - TO model( metadatum BelongsTo model, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
+ required:
+ - metaname
+ - metaval
+ 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.
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-element isA model, MANY2ONE)
+ - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+ - FROM model-element( model-element isA model, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -(2) IF this MODEL node is deleted, this TO node is DELETED also
+ -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
+
+ required:
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ 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-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/getDefinitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/getDefinitions/instance-filters"
+ top-node-type:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( 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
+ required:
+ - model-constraint-uuid
+ - constrained-element-set-uuid-to-replace
+ properties:
+ model-constraint-uuid:
+ type: string
+ constrained-element-set-uuid-to-replace:
+ type: string
+ constrained-element-sets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/constrained-element-set"
+ model-constraints:
+ properties:
+ model-constraint:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-constraint"
+ model-element:
+ description: |
+ Defines how other models combine to make up a higher-level model.
+ ###### Related Nodes
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model( model-element isA model, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model (PARENT of model-element, model startsWith model-element)(3)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
+ required:
+ - model-element-uuid
+ - new-data-del-flag
+ - cardinality
+ 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: "#/getDefinitions/model-element"
+ description: Defines how other models combine to make up a higher-level model
+ model-constraints:
+ type: array
+ items:
+ $ref: "#/getDefinitions/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: "#/getDefinitions/relationship"
+ model-elements:
+ properties:
+ model-element:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ model-ver:
+ 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( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM metadatum( metadatum 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
+
+ required:
+ - model-version-id
+ - model-name
+ - model-version
+ 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
+ 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: "#/getDefinitions/model-element"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-ver"
+ models:
+ description: |
+ Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
+ properties:
+ model:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model"
+ multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
+ required:
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
+ 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: "#/getDefinitions/relationship"
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
+ properties:
+ multicast-configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query"
+ named-query:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
+ required:
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
+ 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: "#/getDefinitions/named-query-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ named-query-element:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(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
+ required:
+ - named-query-element-uuid
+ 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: "#/getDefinitions/named-query-element"
+ related-lookups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-lookup"
+ property-constraints:
+ type: array
+ items:
+ $ref: "#/getDefinitions/property-constraint"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ named-query-elements:
+ properties:
+ named-query-element:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query-element"
+ network:
+ description: |
+ Namespace for network inventory resources.
+ properties:
+ logical-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/logical-link"
+ site-pair-sets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair-set"
+ vpn-bindings:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpn-binding"
+ vpls-pes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpls-pe"
+ multicast-configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/multicast-configuration"
+ vces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vce"
+ vnfcs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnfc"
+ l3-networks:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-table-reference"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
+ required:
+ - network-policy-id
+ 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: "#/getDefinitions/relationship"
+ network-profile:
+ description: |
+ Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
+ required:
+ - nm-profile-name
+ 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: "#/getDefinitions/relationship"
+ network-profiles:
+ description: |
+ Collection of network profiles
+ properties:
+ network-profile:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-profile"
+ newvce:
+ 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( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
+ required:
+ - vnf-id2
+ - vnf-name
+ - vnf-type
+ 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 and clients should expect changes to occur in the future to this field as ASDC matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ 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: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ newvces:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ properties:
+ newvce:
+ type: array
+ items:
+ $ref: "#/getDefinitions/newvce"
+ nodes:
+ properties:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item-data"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/getDefinitions/notification-event-header"
+ notification-event-header:
+ 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:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ 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
+ format: int64
+ description: cvlan-id
+ 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
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ 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: "#/getDefinitions/relationship"
+ oam-networks:
+ description: |
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
+ properties:
+ oam-network:
+ type: array
+ items:
+ $ref: "#/getDefinitions/oam-network"
+ operational-environment:
+ 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, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
+ required:
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
+ 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: "#/getDefinitions/relationship"
+ operational-environments:
+ description: |
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ properties:
+ operational-environment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/operational-environment"
+ overloaded-model:
+ description: |
+ Allows for legacy POST of old-style and new-style models
+ required:
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ 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:
+ type: object
+ $ref: "#/getDefinitions/model-vers"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/getDefinitions/owning-entity"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ 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: "#/getDefinitions/relationship"
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+
+ -(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
+ required:
+ - interface-name
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the physical interface
+ 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.
+ 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: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ physical-link:
+ 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
+ required:
+ - link-name
+ 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.
+ 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: "#/getDefinitions/relationship"
+ physical-links:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ properties:
+ physical-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
+ required:
+ - platform-name
+ 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: "#/getDefinitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/getDefinitions/platform"
+ pnf:
+ description: |
+ PNF represents a physical network function. typically equipment used in the D1 world.
+ ###### Related Nodes
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
+ required:
+ - pnf-name
+ - in-maint
+ properties:
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ 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 by company or customer
+ 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.
+ orchestration-status:
+ type: string
+ description: orchestration-status is the status of orchestration 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.
+ 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: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pnf"
+ port-group:
+ description: |
+ Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( 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
+ required:
+ - interface-id
+ - orchestration-status
+ 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: "#/getDefinitions/cvlan-tag-entry"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ port-groups:
+ properties:
+ port-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/port-group"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
+ required:
+ - project-name
+ 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: "#/getDefinitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/getDefinitions/project"
+ properties:
+ description: |
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
+ type: string
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
+ type: string
+ resource-version:
+ type: string
+ property-constraints:
+ properties:
+ property-constraint:
+ type: array
+ items:
+ $ref: "#/getDefinitions/property-constraint"
+ pserver:
+ description: |
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ ###### Related Nodes
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( 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 GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
+ required:
+ - hostname
+ - in-maint
+ 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
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ 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
+ 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
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ pservers:
+ description: |
+ Collection of compute hosts.
+ properties:
+ pserver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/getDefinitions/named-query"
+ model:
+ type: object
+ $ref: "#/getDefinitions/model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
+ required:
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
+ 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: "#/getDefinitions/relationship"
+ related-lookups:
+ properties:
+ related-lookup:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-lookup"
+ related-to-property:
+ 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:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship-data"
+ related-to-property:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-to-property"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ 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-list:
+ properties:
+ relationship:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ reserved-prop-names:
+ description: |
+ Internal map to define some reserved properties of a vertex
+ 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
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/getDefinitions/inventory-response-items"
+ result-data:
+ 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:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ 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: "#/getDefinitions/relationship"
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
+ required:
+ - global-route-target
+ - route-target-role
+ 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: "#/getDefinitions/relationship"
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( 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
+ required:
+ - routing-instance-id
+ 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: "#/getDefinitions/site-pair"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/getDefinitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/getDefinitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/getDefinitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/getDefinitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/getDefinitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/getDefinitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/getDefinitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
+ type: string
+ filter-type:
+ type: string
+ property-value:
+ type: string
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/getDefinitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
+ required:
+ - segmentation-id
+ 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: "#/getDefinitions/relationship"
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
+ required:
+ - service-id
+ - service-description
+ 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: "#/getDefinitions/relationship"
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-capability"
+ service-capability:
+ 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
+
+ required:
+ - service-type
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC 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: "#/getDefinitions/relationship"
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query"
+ service-instance:
+ description: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(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
+ required:
+ - service-instance-id
+ 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.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ 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.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ service-instances:
+ description: |
+ Collection of service instances
+ properties:
+ service-instance:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-instance"
+ service-subscription:
+ description: |
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( 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
+ required:
+ - service-type
+ properties:
+ service-type:
+ type: string
+ description: Value defined by orchestration to identify this service across ECOMP.
+ 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: "#/getDefinitions/service-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( 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
+ required:
+ - site-pair-id
+ 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, 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: "#/getDefinitions/class-of-service"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ 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( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
+ required:
+ - site-pair-set-id
+ 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: "#/getDefinitions/routing-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
+ required:
+ - snapshot-id
+ 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: "#/getDefinitions/relationship"
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/getDefinitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( 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
+ required:
+ - pf-pci-id
+ 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: "#/getDefinitions/relationship"
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
+ required:
+ - pci-id
+ 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: "#/getDefinitions/relationship"
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - 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)
+
+ -(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
+
+ required:
+ - subnet-id
+ - dhcp-enabled
+ 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
+ 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: "#/getDefinitions/relationship"
+ subnets:
+ properties:
+ subnet:
+ type: array
+ items:
+ $ref: "#/getDefinitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( 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 service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
+ required:
+ - tenant-id
+ - tenant-name
+ properties:
+ tenant-id:
+ type: string
+ description: Unique id relative to the cloud-region.
+ tenant-name:
+ type: string
+ description: Readable name of tenant
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vserver"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ tenants:
+ description: |
+ Collection of openstack tenants.
+ properties:
+ tenant:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tenant"
+ tunnel-xconnect:
+ description: |
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
+ required:
+ - id
+ - bandwidth-up-wan1
+ - bandwidth-down-wan1
+ - bandwidth-up-wan2
+ - bandwidth-down-wan2
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
+ type: string
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
+ type: string
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ properties:
+ tunnel-xconnect:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tunnel-xconnect"
+ update:
+ description: |
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
+ required:
+ - update-node-type
+ properties:
+ update-node-type:
+ type: string
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/getDefinitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/getDefinitions/action"
+ update-node-key:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ 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 port-group( 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
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
+ 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-state:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: License key
+ 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: Entitlement resource uuid
+ port-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/port-group"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ properties:
+ vce:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vce"
+ vf-module:
+ description: |
+ a deployment unit of VNFCs
+ ###### Related Nodes
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
+ required:
+ - vf-module-id
+ - is-base-vf-module
+ 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
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ persona-model-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version 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.
+ contrail-service-instance-fqdn:
+ type: string
+ description: the Contrail unique ID for a service-instance
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vf-module"
+ 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( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
+ required:
+ - vig-address-type
+ 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: "#/getDefinitions/relationship"
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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: "#/getDefinitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - 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)
+
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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: "#/getDefinitions/relationship"
+ 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)
+
+ required:
+ - vdc-id
+ - vdc-name
+ 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: "#/getDefinitions/relationship"
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
+ type: array
+ items:
+ $ref: "#/getDefinitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(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
+ required:
+ - vlan-interface
+ properties:
+ vlan-interface:
+ type: string
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ 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-id:
+ type: string
+ description: This indicates the customers VPN ID associated with this vlan
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ vlans:
+ properties:
+ vlan:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ 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
+
+ required:
+ - vnf-image-uuid
+ - application
+ - application-vendor
+ 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: "#/getDefinitions/relationship"
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ properties:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
+ required:
+ - vnfc-name
+ - vnfc-function-code
+ - vnfc-type
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ vnfc-function-code:
+ type: string
+ description: function code
+ vnfc-type:
+ type: string
+ description: type
+ 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
+ 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: "#/getDefinitions/relationship"
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
+ required:
+ - volume-id
+ - volume-selflink
+ 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: "#/getDefinitions/relationship"
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ 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 ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this 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: "#/getDefinitions/relationship"
+ volume-groups:
+ description: |
+ Collection of persistent block-level storage.
+ properties:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume"
+ vpls-pe:
+ 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( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
+ required:
+ - equipment-name
+ 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
+ format: int64
+ description: Temporary location for stag to get to VCE
+ 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: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ vpls-pes:
+ description: |
+ Collection of VPLS Provider Edge routers
+ properties:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+
+ -VPN-BINDING cannot be deleted if related to L3-NETWORK
+
+ required:
+ - vpn-id
+ - vpn-name
+ - global-route-target
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ global-route-target:
+ type: string
+ description: Number used to identify a VPN, globally unique in the network
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ 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: "#/getDefinitions/relationship"
+ description: l3-networks relate to vpn-bindings
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - 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 volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - 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
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ 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: "#/getDefinitions/volume"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
+ properties:
+ vserver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vserver"
+ 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)
+
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
+ 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
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
+ type: array
+ items:
+ $ref: "#/getDefinitions/zone"
Code Review / aai / aai-common.git / blobdiff