swagger: "2.0"
info:
description: |
+
+ [Differences versus the previous schema version](apidocs/aai_swagger_v11.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/v11/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
+ example: __AVAILABILITY-ZONE-NAME__
- name: data-center-code
in: query
description: Data center code which can be an alternate way to identify a complex
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/v11/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 created or 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
+ example: __PHYSICAL-LOCATION-ID__
- name: data-center-code
in: query
description: Data center code which can be an alternate way to identify a complex
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/v11/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
+ example: __PHYSICAL-LOCATION-ID__
- name: data-center-code
in: query
description: Data center code which can be an alternate way to identify a complex
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/v11/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 created or 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/).
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-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: 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/v11/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
+ example: __VOLUME-GROUP-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __VOLUME-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
tags:
- CloudInfrastructure
summary: create or update an existing volume
- description: 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
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 created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
required: true
schema:
$ref: "#/definitions/volume"
+ patch:
+ tags:
+ - CloudInfrastructure
+ 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
+ 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: 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.
+ required: true
+ schema:
+ $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
+ example: __VSERVER-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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: 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.
+ required: true
+ schema:
+ $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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ 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
+ 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: 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.
+ required: true
+ schema:
+ $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:
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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
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: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.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: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ 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: 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.
+ required: true
+ schema:
+ $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
+ example: __INTERFACE-NAME__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __PCI-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
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: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ 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: 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.
+ required: true
+ schema:
+ $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"
+ $ref: "#/getDefinitions/sriov-vfs"
"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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
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-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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ 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
- - 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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- 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: 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: 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 created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
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
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
- 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: 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: l3-interface-ipv6-address
+ 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: tenant-context
- in: query
- description: This field will store the tenant context.
- 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
+ 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
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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
+ 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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
- 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}:
+ 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:
- CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - 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: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ 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
+ 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ 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: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ 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
+ 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: 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ 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:
+ "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: 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/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
+ 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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __VSERVER-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
"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
+ example: __VSERVER-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __TENANT-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __TENANT-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __FLAVOR-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __GROUP-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __SNAPSHOT-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
required: true
schema:
$ref: "#/definitions/snapshot"
+ patch:
+ tags:
+ - CloudInfrastructure
+ 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
+ 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: 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/snapshot"
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: 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: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/snapshots"
+ $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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.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: 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:
"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: 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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
tags:
- CloudInfrastructure
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
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: 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/v11/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 created or 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
+ example: __IMAGE-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
"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
+ example: __IMAGE-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __SWITCH-NAME__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
required: true
schema:
$ref: "#/definitions/dvs-switch"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing dvs-switch
- description: delete an existing dvs-switch
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ 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
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: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
- get:
- tags:
- - CloudInfrastructure
- summary: returns dvs-switches
- description: returns dvs-switches
- operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/dvs-switches"
- "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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
- 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: network-uuid
- in: path
- description: UUID of the network. Unique across a cloud-region
- required: true
- type: string
+ example: __SWITCH-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: dvs-switch object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/dvs-switch"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ summary: delete an existing dvs-switch
+ description: delete an existing dvs-switch
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
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: network-uuid
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
+ example: __SWITCH-NAME__
+ - 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}/dvs-switches:
get:
tags:
- CloudInfrastructure
- summary: returns oam-network
- description: returns oam-network
- operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ summary: returns dvs-switches
+ description: returns dvs-switches
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/oam-network"
+ $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
+ example: __CLOUD-REGION-ID__
+ - 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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ 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__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns oam-network
+ description: returns oam-network
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/oam-network"
+ "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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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
+ example: __AVAILABILITY-ZONE-NAME__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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 created or 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
+ example: __CLOUD-REGION-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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/v11/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}/esr-system-info-list/esr-system-info/{esr-system-info-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: esr-system-info-id
in: path
description: Unique ID of esr system info.
required: true
type: string
+ example: __ESR-SYSTEM-INFO-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/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.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: esr-system-info-id
in: path
description: Unique ID of esr system info.
required: true
type: string
+ example: __ESR-SYSTEM-INFO-ID__
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-system-info"
+ $ref: "#/getDefinitions/esr-system-info"
"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: esr-system-info-id
in: path
description: Unique ID of esr system info.
required: true
type: string
+ example: __ESR-SYSTEM-INFO-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
tags:
- CloudInfrastructure
summary: create or update an existing esr-system-info
- description: create or update an existing esr-system-info
+ description: |
+ Create or update an existing esr-system-info.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
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: esr-system-info-id
in: path
description: Unique ID of esr system info.
required: true
type: string
+ example: __ESR-SYSTEM-INFO-ID__
- name: body
in: body
- description: esr-system-info object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
required: true
schema:
$ref: "#/definitions/esr-system-info"
- delete:
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing esr-system-info
- description: delete an existing esr-system-info
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
+ summary: update an existing esr-system-info
+ description: |
+ Update an existing esr-system-info
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
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: esr-system-info-id
in: path
description: Unique ID of esr system info.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __ESR-SYSTEM-INFO-ID__
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated.
required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
- get:
+ schema:
+ $ref: "#/patchDefinitions/esr-system-info"
+ delete:
tags:
- CloudInfrastructure
- summary: returns esr-system-info-list
- description: returns esr-system-info-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/esr-system-info-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
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
type: string
- - name: owner-defined-type
+ example: __ESR-SYSTEM-INFO-ID__
+ - name: resource-version
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
get:
tags:
- CloudInfrastructure
- summary: returns cloud-region
- description: returns cloud-region
- operationId: getCloudInfrastructureCloudRegionsCloudRegion
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/cloud-region"
+ $ref: "#/getDefinitions/esr-system-info-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: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
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}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing cloud-region
- description: create or update an existing cloud-region
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
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: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
- name: body
in: body
- description: cloud-region 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/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/cloud-region"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing cloud-region
- description: delete an existing cloud-region
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
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: resource-version
- in: query
- description: resource-version for concurrency
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
required: true
type: string
- /cloud-infrastructure/cloud-regions:
+ example: __VIP-IPV4-ADDRESS__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
get:
tags:
- CloudInfrastructure
- summary: returns cloud-regions
- description: returns cloud-regions
- operationId: getCloudInfrastructureCloudRegions
+ summary: returns vip-ipv4-address-list
+ description: returns vip-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/cloud-regions"
+ $ref: "#/getDefinitions/vip-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
+ 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: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - 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: 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:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ summary: create or update an existing vip-ipv4-address-list
+ description: |
+ Create or update an existing vip-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ 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: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/relationship"
- delete:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ summary: update an existing vip-ipv4-address-list
+ description: |
+ Update an existing vip-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns network-profile
- description: returns network-profile
- operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/network-profile"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: nm-profile-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Unique name of network profile.
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- put:
- tags:
- - CloudInfrastructure
- summary: create or update an existing network-profile
- description: create or update an existing network-profile
- operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
- 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
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
in: path
- description: Unique name of network profile.
+ description: IP address
required: true
type: string
+ example: __VIP-IPV4-ADDRESS__
- name: body
in: body
- description: network-profile object that needs to be created or updated
+ description: vip-ipv4-address-list object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/network-profile"
+ $ref: "#/patchDefinitions/vip-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing network-profile
- description: delete an existing network-profile
- operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
+ summary: delete an existing vip-ipv4-address-list
+ description: delete an existing vip-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: nm-profile-name
+ - name: cloud-owner
in: path
- description: Unique name of network profile.
+ 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: vip-ipv4-address
+ in: path
+ description: IP address
required: true
type: string
+ example: __VIP-IPV4-ADDRESS__
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /cloud-infrastructure/network-profiles:
- get:
- tags:
- - CloudInfrastructure
- summary: returns network-profiles
- description: returns network-profiles
- operationId: getCloudInfrastructureNetworkProfiles
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/network-profiles"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ 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: vip-ipv6-address
+ in: path
+ description: IP address
required: true
type: string
+ example: __VIP-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/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
- 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
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: interface-name
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
in: path
- description: Name that identifies the physical interface
+ description: IP address
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: __VIP-IPV6-ADDRESS__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vip-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - 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: 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:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ summary: create or update an existing vip-ipv6-address-list
+ description: |
+ Create or update an existing vip-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: pf-pci-id
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
in: path
- description: Identifier for the sriov-pf
+ description: IP address
required: true
type: string
+ example: __VIP-IPV6-ADDRESS__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/relationship"
- delete:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ summary: update an existing vip-ipv6-address-list
+ description: |
+ Update an existing vip-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: pf-pci-id
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
in: path
- description: Identifier for the sriov-pf
+ description: IP address
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
- get:
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vip-ipv6-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: returns sriov-pf
- description: returns sriov-pf
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-pf"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: pf-pci-id
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
in: path
- description: Identifier for the sriov-pf
+ description: IP address
required: true
type: string
- - name: inv-status
+ example: __VIP-IPV6-ADDRESS__
+ - name: resource-version
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- - name: pserver-id
- in: query
- description: ID of Pserver
- required: false
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns cloud-region
+ description: returns cloud-region
+ operationId: getCloudInfrastructureCloudRegionsCloudRegion
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/cloud-region"
+ "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: pserver-name2
+ 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: cloud-type
in: query
- description: alternative pserver name
+ description: Type of the cloud (e.g., openstack)
required: false
type: string
- - name: prov-status
+ - name: owner-defined-type
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing sriov-pf
- description: create or update an existing sriov-pf
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ summary: 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
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: cloud-owner
in: path
- description: Value from executing hostname on the compute node.
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: interface-name
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Name that identifies the physical interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- - name: pf-pci-id
+ example: __CLOUD-REGION-ID__
+ - name: body
+ in: body
+ description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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: Identifier for the sriov-pf
+ 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: sriov-pf object that needs to be created or updated
+ description: cloud-region object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/sriov-pf"
+ $ref: "#/patchDefinitions/cloud-region"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing sriov-pf
- description: delete an existing sriov-pf
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ summary: delete an existing cloud-region
+ description: delete an existing cloud-region
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
consumes:
- application/json
- application/xml
"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
+ - name: cloud-owner
in: path
- description: Name that identifies the physical interface
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- - name: pf-pci-id
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: Identifier for the sriov-pf
+ 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
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ /cloud-infrastructure/cloud-regions:
get:
tags:
- CloudInfrastructure
- summary: returns sriov-pfs
- description: returns sriov-pfs
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
+ summary: returns cloud-regions
+ description: returns cloud-regions
+ operationId: getCloudInfrastructureCloudRegions
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-pfs"
+ $ref: "#/getDefinitions/cloud-regions"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ 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
+ - name: nm-profile-name
in: path
- description: Value from executing hostname on the compute node.
+ description: Unique name of network profile.
required: true
type: string
- - name: interface-name
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ 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: Name that identifies the physical interface
+ description: Unique name of network profile.
required: true
type: string
- - name: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __NM-PROFILE-NAME__
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profile
+ description: returns network-profile
+ operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-profile"
+ "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
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ example: __NM-PROFILE-NAME__
put:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ summary: 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
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: hostname
+ - name: nm-profile-name
in: path
- description: Value from executing hostname on the compute node.
+ description: Unique name of network profile.
required: true
type: string
- - name: interface-name
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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: Name that identifies the physical interface
+ description: Unique name of network profile.
required: true
type: string
- - name: interface-name
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: network-profile object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/network-profile"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing network-profile
+ description: delete an existing network-profile
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
+ 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: Name given to the interface
+ description: Unique name of network profile.
required: true
type: string
- - name: vlan-interface
+ example: __NM-PROFILE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/network-profiles:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profiles
+ description: returns network-profiles
+ operationId: getCloudInfrastructureNetworkProfiles
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-profiles"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
+ 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: String that identifies the interface
+ 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/v11/CloudInfrastructurePserversPserver.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
- - name: interface-name
+ example: __HOSTNAME__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ 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: Name that identifies the physical interface
+ description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: interface-name
in: path
- description: Name given to the interface
+ description: Name that identifies the physical interface
required: true
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
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
- - name: interface-name
+ example: __INTERFACE-NAME__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ 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: Name given to the interface
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: vlan-interface
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name that identifies the physical interface
required: true
type: string
- - name: l3-interface-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: IP address
+ description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
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
- - 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-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: IP address
+ description: Identifier for the sriov-pf
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-ipv4-address-list/{l3-interface-ipv4-address}:
+ example: __PF-PCI-ID__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
get:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: returns sriov-pf
+ description: returns sriov-pf
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $ref: "#/getDefinitions/sriov-pf"
"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: 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-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: IP address
+ description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Trigger for operational monitoring of this resource by 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-key
- 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:
- CloudInfrastructure
- summary: create or update an existing l3-interface-ipv4-address-list
- description: create or update an existing l3-interface-ipv4-address-list
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
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
- - 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-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: IP address
+ description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ $ref: "#/definitions/sriov-pf"
+ 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 sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
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
- - name: interface-name
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: Name given to the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- - name: vlan-interface
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-pf"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ 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: String that identifies the interface
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: l3-interface-ipv4-address
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: IP address
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
"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: interface-name
- in: path
- description: Name given to the interface
- required: true
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
type: string
- - name: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ put:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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
- in: path
- description: IP address
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
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}:
- get:
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
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:
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
- in: path
- description: IP address
- required: true
- type: string
- - name: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by 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-key
- 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: __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:
- 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: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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
+ example: __L3-INTERFACE-IPV4-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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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: 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}/vlans/vlan/{vlan-interface}:
+ 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:
- CloudInfrastructure
- summary: returns vlan
- description: returns vlan
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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:
- CloudInfrastructure
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: vlan 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/vlan"
- delete:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ 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
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
- get:
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: returns vlans
- description: returns vlans
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
+ 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
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- 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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- - name: network-name
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
in: query
- description: Name of the network
- required: false
+ 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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
+ /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: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ 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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
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}:
+ 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:
- CloudInfrastructure
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vf"
+ $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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ 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: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
required: false
type: string
- - name: vf-vlan-filter
+ - name: vlan-id-inner
in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ description: Inner VLAN tag
required: false
- type: string
- - name: vf-mac-filter
+ type: integer
+ format: int64
+ - name: vpn-key
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.
+ description: This indicates the customers VPN ID associated with this vlan
required: false
type: string
- - name: vf-vlan-strip
+ - name: vlan-id-inner
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.
+ description: Inner VLAN tag
required: false
- type: boolean
+ type: integer
+ format: int64
- name: neutron-network-id
in: query
- description: Neutron network id of the interface
+ 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:
- CloudInfrastructure
- summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ 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
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: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ 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: sriov-vf 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ 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
+ 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__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ 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
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
get:
tags:
- CloudInfrastructure
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
+ summary: returns vlan
+ description: returns vlan
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $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
+ example: __VLAN-INTERFACE__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
required: false
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
put:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
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: body
in: body
- description: relationship 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
- $ref: "#/definitions/relationship"
- delete:
+ $ref: "#/definitions/vlan"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ 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
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
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
- 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
- - name: l3-interface-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: IP address
+ 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: vlan object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/vlan"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
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
- - name: l3-interface-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: IP address
+ description: String that identifies the interface
required: true
type: string
- /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}:
+ example: __VLAN-INTERFACE__
+ - 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}/vlans:
get:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: returns vlans
+ description: returns vlans
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
+ $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: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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
- 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
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
- type: string
- - name: body
- in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- 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
- - 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
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: path
- description: IP address
+ 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: path
- description: IP address
+ description: PCI ID used to identify the sriov-vf
required: true
type: string
- /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}:
+ 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:
- CloudInfrastructure
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: path
- description: IP address
+ description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
required: false
type: string
- - name: vlan-id-inner
+ - name: vf-vlan-filter
in: query
- description: Inner VLAN tag
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
required: false
- type: integer
- format: int64
- - name: neutron-network-id
+ type: string
+ - name: vf-mac-filter
in: query
- description: Neutron network id of the interface that address belongs to
+ 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: neutron-subnet-id
+ - name: vf-vlan-strip
in: query
- description: Neutron id of subnet that address belongs to
+ 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
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
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: path
- description: IP address
+ description: PCI ID used to identify the sriov-vf
required: true
type: string
+ example: __PCI-ID__
- name: body
in: body
- description: l3-interface-ipv6-address-list 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $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 created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: pci-id
in: path
- description: IP address
+ 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
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
get:
tags:
- CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
required: false
type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
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: body
in: body
- description: l-interface 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
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
- - 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:
- get:
+ 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:
- CloudInfrastructure
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
+ 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
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
- in: query
- description: alternative pserver name
- required: false
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
+ 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:
- CloudInfrastructure
- summary: returns p-interface
- description: returns p-interface
- operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/p-interface"
+ $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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Trigger for operational monitoring of this resource by 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
put:
tags:
- CloudInfrastructure
- summary: create or update an existing p-interface
- description: create or update an existing p-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
+ 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: p-interface 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/p-interface"
- delete:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing p-interface
- description: delete an existing p-interface
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
+ 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
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: resource-version
- in: query
- description: resource-version for concurrency
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
- get:
+ 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: returns p-interfaces
- description: returns p-interfaces
- operationId: getCloudInfrastructurePserversPserverPInterfaces
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
+ 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
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ 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: alternative pserver name
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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
+ 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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- 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
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- 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:
- tags:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- 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
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- 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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- 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
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - 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
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- 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
+ 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: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
in: path
description: IP address
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-ipv4-address-list/{l3-interface-ipv4-address}:
+ 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:
- CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-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
+ 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: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: alternative pserver name
required: false
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
+ - name: prov-status
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- name: interface-id
required: false
type: integer
format: int64
- - name: vpn-key
- 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
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
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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
+ 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: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - name: l3-interface-ipv4-address
+ 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-ipv4-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/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
- tags:
- - CloudInfrastructure
- 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
- 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
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
- - 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
- /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:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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 link aggregate interface
+ 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: vlan-interface
- in: path
- description: String that identifies 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: l3-interface-ipv6-address-list object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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 link aggregate interface
+ 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: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
- type: string
+ example: __INTERFACE-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
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}:
+ 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 l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/getDefinitions/l-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
+ 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: 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: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: alternative pserver name
required: false
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
+ - name: prov-status
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- name: interface-id
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-key
- 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:
- 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: 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
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
+ 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: vlan-interface
+ 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/v11/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: String that identifies the interface
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: l3-interface-ipv6-address
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: IP address
+ 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: l3-interface-ipv6-address-list object that needs to be created or updated
+ description: l-interface object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $ref: "#/patchDefinitions/l-interface"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
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
+ 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: 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: __INTERFACE-NAME__
- 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}:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
get:
tags:
- CloudInfrastructure
- summary: returns vlan
- description: returns vlan
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlan"
+ $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: 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
+ description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: alternative pserver name
required: false
type: string
- - name: interface-id
+ - name: prov-status
in: query
- description: ID of interface
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- required: false
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns p-interface
+ description: returns p-interface
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-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-id
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
in: query
- description: ID of interface
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
required: false
type: string
- - name: macaddr
+ - name: pserver-id
in: query
- description: MAC address for the interface
+ description: ID of Pserver
required: false
type: string
- - name: network-name
+ - name: in-maint
in: query
- description: Name of the network
required: false
- type: string
- - name: vlan-id-inner
+ type: boolean
+ - name: pserver-name2
in: query
- description: Inner VLAN tag
+ description: alternative pserver name
required: false
- type: integer
- format: int64
- - name: vpn-key
+ type: string
+ - name: prov-status
in: query
- description: This indicates the customers VPN ID associated with this vlan
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: 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
- 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
+ description: Name that identifies the physical interface
required: true
type: string
- - name: interface-name
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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: Name given to the interface
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: vlan-interface
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: String that identifies the interface
+ description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: vlan object that needs to be created or updated
+ description: p-interface object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/patchDefinitions/p-interface"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: delete an existing p-interface
+ description: delete an existing p-interface
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
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
- - 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
+ description: Name that identifies the physical interface
required: true
type: string
+ example: __INTERFACE-NAME__
- 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:
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
get:
tags:
- CloudInfrastructure
- summary: returns vlans
- description: returns vlans
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ summary: returns p-interfaces
+ description: returns p-interfaces
+ operationId: getCloudInfrastructurePserversPserverPInterfaces
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vlans"
+ $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: 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: __HOSTNAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: alternative pserver name
required: false
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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
- /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:
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
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
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
+ 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__
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
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}:
- get:
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- CloudInfrastructure
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
type: string
- - name: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- 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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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: __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:
- CloudInfrastructure
- summary: create or update an existing sriov-vf
- description: create or update an existing sriov-vf
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ 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: sriov-vf 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/sriov-vf"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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
- - name: pci-id
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: PCI ID used to identify the sriov-vf
+ description: String that identifies the interface
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ 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:
- CloudInfrastructure
- summary: returns sriov-vfs
- description: returns sriov-vfs
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-vfs"
+ $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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
required: false
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ 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:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: body
in: body
- description: relationship 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/relationship"
+ $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: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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-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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ 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
- /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:
+ 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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
- - name: l3-interface-ipv4-address
+ 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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
- - name: l3-interface-ipv4-address
+ 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
- /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}:
+ 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:
- CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv4-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
- - name: l3-interface-ipv4-address
+ 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: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
required: false
type: integer
format: int64
+ - name: vpn-key
+ 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
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
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ 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
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: l3-interface-ipv4-address
+ 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-ipv4-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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- delete:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing l3-interface-ipv4-address-list
- description: delete an existing l3-interface-ipv4-address-list
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ 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
- - 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
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- 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
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: Name given to the interface
+ 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: l3-interface-ipv6-address-list object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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
- /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}:
+ 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}/vlans/vlan/{vlan-interface}:
get:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: returns vlan
+ description: returns vlan
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
+ $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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: IP address
+ description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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
+ - name: vpn-key
in: query
- description: Neutron id of subnet that address belongs to
+ description: This indicates the customers VPN ID associated with this vlan
required: false
type: string
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
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
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
- - name: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: IP address
+ description: String that identifies the interface
required: true
type: string
+ example: __VLAN-INTERFACE__
- name: body
in: body
- description: l3-interface-ipv6-address-list 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
+ $ref: "#/definitions/vlan"
+ 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 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
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: l3-interface-ipv6-address
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
in: path
- description: IP address
+ description: String that identifies the interface
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
required: true
- type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
- get:
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
tags:
- CloudInfrastructure
- summary: returns l-interface
- description: returns l-interface
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ 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: 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:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlans
+ description: returns vlans
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interface"
+ $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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Name of the network
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:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing l-interface
- description: create or update an existing l-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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: 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: l-interface 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
required: true
schema:
- $ref: "#/definitions/l-interface"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing l-interface
- description: delete an existing l-interface
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
required: true
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ 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:
- CloudInfrastructure
- summary: returns l-interfaces
- description: returns l-interfaces
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/l-interfaces"
+ $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
+ example: __PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
- get:
+ - 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
+ put:
tags:
- CloudInfrastructure
- summary: returns lag-interface
- description: returns lag-interface
- operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- 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
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
tags:
- CloudInfrastructure
- summary: create or update an existing lag-interface
- description: create or update an existing lag-interface
- operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ 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
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: lag-interface object that needs to be created or updated
+ description: sriov-vf object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/lag-interface"
+ $ref: "#/patchDefinitions/sriov-vf"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing lag-interface
- description: delete an existing lag-interface
- operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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: 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
- /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
get:
tags:
- CloudInfrastructure
- summary: returns lag-interfaces
- description: returns lag-interfaces
- operationId: getCloudInfrastructurePserversPserverLagInterfaces
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/lag-interfaces"
+ $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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
description: alternative pserver name
required: false
type: string
- /cloud-infrastructure/pservers/pserver/{hostname}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns pserver
- description: returns pserver
- operationId: getCloudInfrastructurePserversPserver
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/pserver"
- "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
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
type: string
- - name: inv-status
+ - name: interface-role
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
- - name: pserver-id
+ - name: interface-id
in: query
- description: ID of Pserver
+ description: ID of interface
required: false
type: string
- - name: in-maint
+ - name: macaddr
in: query
+ description: MAC address for the interface
required: false
- type: boolean
- - name: pserver-name2
+ type: string
+ - name: network-name
in: query
- description: alternative pserver name
+ description: Name of the network
required: false
type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing pserver
- description: create or update an existing pserver
- operationId: createOrUpdateCloudInfrastructurePserversPserver
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
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: body
in: body
- description: pserver 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
- $ref: "#/definitions/pserver"
+ $ref: "#/definitions/relationship"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing pserver
- description: delete an existing pserver
- operationId: deleteCloudInfrastructurePserversPserver
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Value from executing hostname on the compute node.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /cloud-infrastructure/pservers:
- get:
- tags:
- - CloudInfrastructure
- summary: returns pservers
- description: returns pservers
- operationId: getCloudInfrastructurePservers
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/pservers"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
+ 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:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vdc-id
+ - name: hostname
in: path
- description: Unique ID of the vdc
+ 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vdc-id
+ - name: hostname
in: path
- description: Unique ID of the vdc
+ description: Value from executing hostname on the compute node.
required: true
type: string
- /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
+ 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:
- CloudInfrastructure
- summary: returns virtual-data-center
- description: returns virtual-data-center
- operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/virtual-data-center"
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vdc-id
+ - name: hostname
in: path
- description: Unique ID of the vdc
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: vdc-name
+ 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: inv-status
in: query
- description: Name of the virtual data center
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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
put:
tags:
- CloudInfrastructure
- summary: create or update an existing virtual-data-center
- description: create or update an existing virtual-data-center
- operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vdc-id
+ - name: hostname
in: path
- description: Unique ID of the vdc
+ 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: virtual-data-center 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
required: true
schema:
- $ref: "#/definitions/virtual-data-center"
- delete:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
tags:
- CloudInfrastructure
- summary: delete an existing virtual-data-center
- description: delete an existing virtual-data-center
- operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vdc-id
+ - name: hostname
in: path
- description: Unique ID of the vdc
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /cloud-infrastructure/virtual-data-centers:
- get:
+ 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- CloudInfrastructure
- summary: returns virtual-data-centers
- description: returns virtual-data-centers
- operationId: getCloudInfrastructureVirtualDataCenters
- produces:
- - application/json
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ 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: 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
put:
tags:
- - ExternalSystem
+ - CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
delete:
tags:
- - ExternalSystem
+ - CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ 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:
- - ExternalSystem
- summary: returns esr-system-info
- description: returns esr-system-info
- operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-system-info"
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- - name: system-name
+ 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: inv-status
in: query
- description: name of external system.
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
required: false
type: string
- - name: system-type
+ - name: pserver-id
in: query
- description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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
put:
tags:
- - ExternalSystem
- summary: create or update an existing esr-system-info
- description: create or update an existing esr-system-info
- operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ - 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ 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: esr-system-info 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
required: true
schema:
- $ref: "#/definitions/esr-system-info"
- delete:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
tags:
- - ExternalSystem
- summary: delete an existing esr-system-info
- description: delete an existing esr-system-info
- operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list:
- get:
- tags:
- - ExternalSystem
- summary: returns esr-system-info-list
- description: returns esr-system-info-list
- operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/esr-system-info-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: ems-id
+ example: __INTERFACE-NAME__
+ - name: interface-name
in: path
- description: Unique ID of EMS.
+ description: Name given to the interface
required: true
type: string
- /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship:
- put:
- tags:
- - ExternalSystem
- summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
- 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: ems-id
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
in: path
- description: Unique ID of EMS.
+ 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: l3-interface-ipv6-address-list object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- - ExternalSystem
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
+ - CloudInfrastructure
+ 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - 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-ipv6-address
in: path
- description: Unique ID of EMS.
+ 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
- /external-system/esr-ems-list/esr-ems/{ems-id}:
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
get:
tags:
- - ExternalSystem
- summary: returns esr-ems
- description: returns esr-ems
- operationId: getExternalSystemEsrEmsListEsrEms
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-ems"
+ $ref: "#/getDefinitions/l-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - 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: Unique ID of EMS.
+ description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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:
- - ExternalSystem
- summary: create or update an existing esr-ems
- description: create or update an existing esr-ems
- operationId: createOrUpdateExternalSystemEsrEmsListEsrEms
+ - 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - 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: Unique ID of EMS.
+ description: Name given to the interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: esr-ems 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
required: true
schema:
- $ref: "#/definitions/esr-ems"
- delete:
+ $ref: "#/definitions/l-interface"
+ patch:
tags:
- - ExternalSystem
- summary: delete an existing esr-ems
- description: delete an existing esr-ems
- operationId: deleteExternalSystemEsrEmsListEsrEms
+ - 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: ems-id
+ - name: hostname
in: path
- description: Unique ID of EMS.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /external-system/esr-ems-list:
- get:
- tags:
- - ExternalSystem
- summary: returns esr-ems-list
- description: returns esr-ems-list
- operationId: getExternalSystemEsrEmsList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
+ 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.
+ required: true
schema:
- $ref: "#/definitions/esr-ems-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
- put:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
tags:
- - ExternalSystem
- summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ type: string
+ example: __INTERFACE-NAME__
+ - 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:
+ get:
tags:
- - ExternalSystem
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ - CloudInfrastructure
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
get:
tags:
- - ExternalSystem
- summary: returns esr-system-info
- description: returns esr-system-info
- operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-system-info"
+ $ref: "#/getDefinitions/lag-interface"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- - name: system-name
+ example: __INTERFACE-NAME__
+ - name: inv-status
in: query
- description: name of external system.
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
required: false
type: string
- - name: system-type
+ - name: pserver-id
in: query
- description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
required: false
type: string
put:
tags:
- - ExternalSystem
- summary: create or update an existing esr-system-info
- description: create or update an existing esr-system-info
- operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: 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
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
+ example: __INTERFACE-NAME__
- name: body
in: body
- description: esr-system-info 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
required: true
schema:
- $ref: "#/definitions/esr-system-info"
- delete:
+ $ref: "#/definitions/lag-interface"
+ patch:
tags:
- - ExternalSystem
- summary: delete an existing esr-system-info
- description: delete an existing esr-system-info
- operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ - 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
+ example: __HOSTNAME__
+ - name: interface-name
in: path
- description: Unique ID of esr system info.
+ description: Name that identifies the link aggregate interface
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated.
required: true
- type: string
- /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list:
- get:
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
+ delete:
tags:
- - ExternalSystem
- summary: returns esr-system-info-list
- description: returns esr-system-info-list
- operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/esr-system-info-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnfm-id
- in: path
- description: Unique ID of VNFM.
- required: true
- type: string
- /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship:
- put:
- tags:
- - ExternalSystem
- summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
- consumes:
+ - CloudInfrastructure
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ consumes:
- application/json
- application/xml
produces:
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
+ get:
tags:
- - ExternalSystem
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ - CloudInfrastructure
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getCloudInfrastructurePserversPserverLagInterfaces
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interfaces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}:
+ example: __HOSTNAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ 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
+ /cloud-infrastructure/pservers/pserver/{hostname}:
get:
tags:
- - ExternalSystem
- summary: returns esr-vnfm
- description: returns esr-vnfm
- operationId: getExternalSystemEsrVnfmListEsrVnfm
+ - CloudInfrastructure
+ summary: returns pserver
+ description: returns pserver
+ operationId: getCloudInfrastructurePserversPserver
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-vnfm"
+ $ref: "#/getDefinitions/pserver"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ 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
put:
tags:
- - ExternalSystem
- summary: create or update an existing esr-vnfm
- description: create or update an existing esr-vnfm
- operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfm
+ - CloudInfrastructure
+ summary: 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
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfm-id
+ - name: hostname
in: path
- description: Unique ID of VNFM.
+ description: Value from executing hostname on the compute node.
required: true
type: string
+ example: __HOSTNAME__
- name: body
in: body
- description: esr-vnfm 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/v11/CloudInfrastructurePserversPserver.json)
required: true
schema:
- $ref: "#/definitions/esr-vnfm"
- delete:
- tags:
- - ExternalSystem
- summary: delete an existing esr-vnfm
- description: delete an existing esr-vnfm
- operationId: deleteExternalSystemEsrVnfmListEsrVnfm
- 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: vnfm-id
- in: path
- description: Unique ID of VNFM.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /external-system/esr-vnfm-list:
- get:
- tags:
- - ExternalSystem
- summary: returns esr-vnfm-list
- description: returns esr-vnfm-list
- operationId: getExternalSystemEsrVnfmList
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/esr-vnfm-list"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
- put:
+ $ref: "#/definitions/pserver"
+ patch:
tags:
- - ExternalSystem
- summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ - 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
- required: true
- type: string
- - name: esr-system-info-id
+ - name: hostname
in: path
- description: Unique ID of esr system info.
+ 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: pserver object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/pserver"
delete:
tags:
- - ExternalSystem
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ - CloudInfrastructure
+ summary: delete an existing pserver
+ description: delete an existing pserver
+ operationId: deleteCloudInfrastructurePserversPserver
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
+ - name: hostname
in: path
- description: Unique ID of SDNC.
+ description: Value from executing hostname on the compute node.
required: true
type: string
- - name: esr-system-info-id
- in: path
- description: Unique ID of esr system info.
+ example: __HOSTNAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ /cloud-infrastructure/pservers:
get:
tags:
- - ExternalSystem
- summary: returns esr-system-info
- description: returns esr-system-info
- operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: returns pservers
+ description: returns pservers
+ operationId: getCloudInfrastructurePservers
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-system-info"
+ $ref: "#/getDefinitions/pservers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
- required: true
- type: string
- - name: esr-system-info-id
- in: path
- description: Unique ID of esr system info.
- required: true
- type: string
- - name: system-name
- in: query
- description: name of external system.
- required: false
- type: string
- - name: system-type
- in: query
- description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
- required: false
- type: string
+ /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
put:
tags:
- - ExternalSystem
- summary: create or update an existing esr-system-info
- description: create or update an existing esr-system-info
- operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
- required: true
- type: string
- - name: esr-system-info-id
+ - name: vdc-id
in: path
- description: Unique ID of esr system info.
+ description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: body
in: body
- description: esr-system-info 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/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
required: true
schema:
- $ref: "#/definitions/esr-system-info"
+ $ref: "#/definitions/relationship"
delete:
tags:
- - ExternalSystem
- summary: delete an existing esr-system-info
- description: delete an existing esr-system-info
- operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
- required: true
- type: string
- - name: esr-system-info-id
+ - name: vdc-id
in: path
- description: Unique ID of esr system info.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ description: Unique ID of the vdc
required: true
type: string
- /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list:
+ example: __VDC-ID__
+ /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
get:
tags:
- - ExternalSystem
- summary: returns esr-system-info-list
- description: returns esr-system-info-list
- operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList
+ - CloudInfrastructure
+ summary: returns virtual-data-center
+ description: returns virtual-data-center
+ operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-system-info-list"
+ $ref: "#/getDefinitions/virtual-data-center"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
+ - name: vdc-id
in: path
- description: Unique ID of SDNC.
+ description: Unique ID of the vdc
required: true
type: string
- /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship:
+ example: __VDC-ID__
+ - name: vdc-name
+ in: query
+ description: Name of the virtual data center
+ required: false
+ type: string
put:
tags:
- - ExternalSystem
- summary: see node definition for valid relationships
- operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ - CloudInfrastructure
+ summary: 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
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
+ - name: vdc-id
in: path
- description: Unique ID of SDNC.
+ 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
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - ExternalSystem
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
- 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: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
+ description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
required: true
- type: string
- /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}:
- get:
- tags:
- - ExternalSystem
- summary: returns esr-thirdparty-sdnc
- description: returns esr-thirdparty-sdnc
- operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
schema:
- $ref: "#/definitions/esr-thirdparty-sdnc"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: thirdparty-sdnc-id
- in: path
- description: Unique ID of SDNC.
- required: true
- type: string
- put:
+ $ref: "#/definitions/virtual-data-center"
+ patch:
tags:
- - ExternalSystem
- summary: create or update an existing esr-thirdparty-sdnc
- description: create or update an existing esr-thirdparty-sdnc
- operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ - 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
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
+ - name: vdc-id
in: path
- description: Unique ID of SDNC.
+ description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: body
in: body
- description: esr-thirdparty-sdnc object that needs to be created or updated
+ description: virtual-data-center object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/esr-thirdparty-sdnc"
+ $ref: "#/patchDefinitions/virtual-data-center"
delete:
tags:
- - ExternalSystem
- summary: delete an existing esr-thirdparty-sdnc
- description: delete an existing esr-thirdparty-sdnc
- operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ - CloudInfrastructure
+ summary: delete an existing virtual-data-center
+ description: delete an existing virtual-data-center
+ operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: thirdparty-sdnc-id
+ - name: vdc-id
in: path
- description: Unique ID of SDNC.
+ description: Unique ID of the vdc
required: true
type: string
+ example: __VDC-ID__
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /external-system/esr-thirdparty-sdnc-list:
+ /cloud-infrastructure/virtual-data-centers:
get:
tags:
- - ExternalSystem
- summary: returns esr-thirdparty-sdnc-list
- description: returns esr-thirdparty-sdnc-list
- operationId: getExternalSystemEsrThirdpartySdncList
+ - CloudInfrastructure
+ summary: returns virtual-data-centers
+ description: returns virtual-data-centers
+ operationId: getCloudInfrastructureVirtualDataCenters
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ $ref: "#/getDefinitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
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/v11/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
+ example: __METANAME__
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
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/v11/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 created or 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
+ example: __RESOURCE-INSTANCE-ID__
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
"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
+ example: __RESOURCE-INSTANCE-ID__
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
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/v11/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 created or 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/).
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/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: 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/v11/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
+ example: __METANAME__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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 created or 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
+ example: __SERVICE-INSTANCE-ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __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/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.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__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnect"
+ $ref: "#/getDefinitions/tunnel-xconnect"
"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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
tags:
- Business
summary: create or update an existing tunnel-xconnect
- description: create or update an existing tunnel-xconnect
+ description: |
+ Create or update an existing tunnel-xconnect.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: body
in: body
- description: tunnel-xconnect object that needs to be created or updated
+ description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
required: true
schema:
$ref: "#/definitions/tunnel-xconnect"
- delete:
+ patch:
tags:
- Business
- summary: delete an existing tunnel-xconnect
- description: delete an existing tunnel-xconnect
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: update an existing tunnel-xconnect
+ description: |
+ Update an existing tunnel-xconnect
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __ID__
+ - name: body
+ in: body
+ description: tunnel-xconnect object that needs to be created or updated.
required: true
- type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
- get:
- tags:
- - Business
- summary: returns tunnel-xconnects
- description: returns tunnel-xconnects
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnects"
- "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
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- 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: environment-context
- in: query
- description: This field will store the environment context assigned to the service-instance.
- required: false
- type: string
- - name: workload-context
- in: query
- description: This field will store the workload context assigned to the service-instance.
- required: false
- type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- 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
- - name: orchestration-status
- in: query
- description: Orchestration status of this service.
- required: false
- type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: type
- in: query
- description: Generic description of the type of allotted resource.
- required: false
- type: string
- - name: role
- in: query
- description: role in the network that this resource will be providing.
- required: false
- type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
- put:
+ $ref: "#/patchDefinitions/tunnel-xconnect"
+ delete:
tags:
- Business
- summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ summary: delete an existing tunnel-xconnect
+ description: delete an existing tunnel-xconnect
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
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:
- tags:
- - Business
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
- 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
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
- type: string
+ example: __ID__
- name: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
+ example: __ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
get:
tags:
- Business
- summary: returns allotted-resource
- description: returns allotted-resource
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: returns tunnel-xconnects
+ description: returns tunnel-xconnects
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/getDefinitions/tunnel-xconnects"
"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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: role in the network that this resource will be providing.
required: false
type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
put:
tags:
- Business
- summary: create or update an existing allotted-resource
- description: create or update an existing allotted-resource
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
consumes:
- application/json
- application/xml
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: body
in: body
- description: allotted-resource 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/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
required: true
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Business
- summary: delete an existing allotted-resource
- description: delete an existing allotted-resource
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
consumes:
- application/json
- application/xml
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: id
in: path
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ example: __ID__
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
get:
tags:
- Business
- summary: returns allotted-resources
- description: returns allotted-resources
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ summary: returns allotted-resource
+ description: returns allotted-resource
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resources"
+ $ref: "#/getDefinitions/allotted-resource"
"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: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - 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: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ 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
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing allotted-resource
+ description: |
+ Create or update an existing allotted-resource.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ 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: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
+ required: true
+ schema:
+ $ref: "#/definitions/allotted-resource"
+ patch:
+ tags:
+ - Business
+ summary: update an existing allotted-resource
+ description: |
+ Update an existing allotted-resource
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ 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: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: allotted-resource object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/allotted-resource"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing allotted-resource
+ description: delete an existing allotted-resource
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ 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: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ get:
+ tags:
+ - Business
+ summary: returns allotted-resources
+ description: returns allotted-resources
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/allotted-resources"
+ "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: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
"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
+ example: __SERVICE-INSTANCE-ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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 created or 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
+ example: __SERVICE-TYPE__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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
+ example: __SERVICE-TYPE__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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 created or 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
+ example: __GLOBAL-CUSTOMER-ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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
+ example: __GLOBAL-CUSTOMER-ID__
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
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/v11/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 created or 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/).
/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
description: Name of the line-of-business (product)
required: true
type: string
+ example: __LINE-OF-BUSINESS-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/v11/BusinessLinesOfBusinessLineOfBusiness.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Name of the line-of-business (product)
required: true
type: string
+ example: __LINE-OF-BUSINESS-NAME__
/business/lines-of-business/line-of-business/{line-of-business-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/line-of-business"
+ $ref: "#/getDefinitions/line-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Name of the line-of-business (product)
required: true
type: string
+ example: __LINE-OF-BUSINESS-NAME__
put:
tags:
- Business
summary: create or update an existing line-of-business
- description: create or update an existing line-of-business
+ description: |
+ Create or update an existing line-of-business.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
consumes:
- application/json
description: Name of the line-of-business (product)
required: true
type: string
+ example: __LINE-OF-BUSINESS-NAME__
- name: body
in: body
- description: line-of-business object that needs to be created or updated
+ description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
required: true
schema:
$ref: "#/definitions/line-of-business"
+ patch:
+ tags:
+ - Business
+ summary: update an existing line-of-business
+ description: |
+ Update an existing line-of-business
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
+ 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: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ - name: body
+ in: body
+ description: line-of-business object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/line-of-business"
delete:
tags:
- Business
description: Name of the line-of-business (product)
required: true
type: string
+ example: __LINE-OF-BUSINESS-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/lines-of-business"
+ $ref: "#/getDefinitions/lines-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
description: UUID of an owning entity
required: true
type: string
+ example: __OWNING-ENTITY-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/v11/BusinessOwningEntitiesOwningEntity.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: UUID of an owning entity
required: true
type: string
+ example: __OWNING-ENTITY-ID__
/business/owning-entities/owning-entity/{owning-entity-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/owning-entity"
+ $ref: "#/getDefinitions/owning-entity"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: UUID of an owning entity
required: true
type: string
+ example: __OWNING-ENTITY-ID__
put:
tags:
- Business
summary: create or update an existing owning-entity
- description: create or update an existing owning-entity
+ description: |
+ Create or update an existing owning-entity.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
consumes:
- application/json
description: UUID of an owning entity
required: true
type: string
+ example: __OWNING-ENTITY-ID__
- name: body
in: body
- description: owning-entity object that needs to be created or updated
+ description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
required: true
schema:
$ref: "#/definitions/owning-entity"
+ patch:
+ tags:
+ - Business
+ summary: update an existing owning-entity
+ description: |
+ Update an existing owning-entity
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessOwningEntitiesOwningEntity
+ 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: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ - name: body
+ in: body
+ description: owning-entity object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/owning-entity"
delete:
tags:
- Business
description: UUID of an owning entity
required: true
type: string
+ example: __OWNING-ENTITY-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/owning-entities"
+ $ref: "#/getDefinitions/owning-entities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/business/platforms/platform/{platform-name}/relationship-list/relationship:
description: Name of the platform
required: true
type: string
+ example: __PLATFORM-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/v11/BusinessPlatformsPlatform.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Name of the platform
required: true
type: string
+ example: __PLATFORM-NAME__
/business/platforms/platform/{platform-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/platform"
+ $ref: "#/getDefinitions/platform"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Name of the platform
required: true
type: string
+ example: __PLATFORM-NAME__
put:
tags:
- Business
summary: create or update an existing platform
- description: create or update an existing platform
+ description: |
+ Create or update an existing platform.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateBusinessPlatformsPlatform
consumes:
- application/json
description: Name of the platform
required: true
type: string
+ example: __PLATFORM-NAME__
- name: body
in: body
- description: platform object that needs to be created or updated
+ description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
required: true
schema:
$ref: "#/definitions/platform"
+ patch:
+ tags:
+ - Business
+ summary: update an existing platform
+ description: |
+ Update an existing platform
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessPlatformsPlatform
+ 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: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ - name: body
+ in: body
+ description: platform object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/platform"
delete:
tags:
- Business
description: Name of the platform
required: true
type: string
+ example: __PLATFORM-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/platforms"
+ $ref: "#/getDefinitions/platforms"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/business/projects/project/{project-name}/relationship-list/relationship:
description: Name of the project deploying a service
required: true
type: string
+ example: __PROJECT-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/v11/BusinessProjectsProject.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Name of the project deploying a service
required: true
type: string
+ example: __PROJECT-NAME__
/business/projects/project/{project-name}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/project"
+ $ref: "#/getDefinitions/project"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Name of the project deploying a service
required: true
type: string
+ example: __PROJECT-NAME__
put:
tags:
- Business
summary: create or update an existing project
- description: create or update an existing project
+ description: |
+ Create or update an existing project.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateBusinessProjectsProject
consumes:
- application/json
description: Name of the project deploying a service
required: true
type: string
+ example: __PROJECT-NAME__
- name: body
in: body
- description: project object that needs to be created or updated
+ description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
required: true
schema:
$ref: "#/definitions/project"
+ patch:
+ tags:
+ - Business
+ summary: update an existing project
+ description: |
+ Update an existing project
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessProjectsProject
+ 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: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ - name: body
+ in: body
+ description: project object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/project"
delete:
tags:
- Business
description: Name of the project deploying a service
required: true
type: string
+ example: __PROJECT-NAME__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/projects"
+ $ref: "#/getDefinitions/projects"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
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/v11/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
+ example: __VNF-IMAGE-UUID__
- name: application
in: query
description: The application that the image instantiates.
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/v11/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 created or 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/).
/service-design-and-creation/services/service/{service-id}/relationship-list/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__
- 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/v11/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
+ example: __SERVICE-ID__
- name: service-description
in: query
description: Description of the service
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/v11/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 created or 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/).
/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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/v11/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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
required: true
schema:
$ref: "#/definitions/service-capability"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ 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
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ - name: body
+ in: body
+ description: service-capability object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-capability"
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-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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
required: true
type: string
+ example: __VNF-TYPE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capabilities"
+ $ref: "#/getDefinitions/service-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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__
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/getDefinitions/element-choice-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
tags:
- ServiceDesignAndCreation
summary: create or update an existing element-choice-set
- description: 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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/element-choice-set"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-sets"
+ $ref: "#/getDefinitions/element-choice-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
get:
tags:
"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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
required: true
schema:
$ref: "#/definitions/constrained-element-set"
- delete:
+ patch:
tags:
- ServiceDesignAndCreation
- summary: delete an existing constrained-element-set
- description: delete an existing constrained-element-set
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ 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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: resource-version
- in: query
- description: resource-version for concurrency
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: constrained-element-set object that needs to be created or updated.
required: true
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
- get:
+ schema:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ delete:
tags:
- ServiceDesignAndCreation
- summary: returns constrained-element-sets
- description: returns constrained-element-sets
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
+ summary: delete an existing constrained-element-set
+ description: delete an existing constrained-element-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/constrained-element-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
type: string
- - name: model-version
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: resource-version
in: query
- description: Version
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-constraint
- description: returns model-constraint
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ summary: returns constrained-element-sets
+ description: returns constrained-element-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraint"
+ $ref: "#/getDefinitions/constrained-element-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Version
required: false
type: string
- put:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
+ get:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model-constraint
- description: create or update an existing model-constraint
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
- consumes:
- - application/json
- - application/xml
+ summary: returns model-constraint
+ description: returns model-constraint
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-constraint"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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: 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-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: 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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-constraint"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
get:
tags:
"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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-element-uuid
in: path
required: true
type: string
+ example: __MODEL-ELEMENT-UUID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
consumes:
- application/json
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-element"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
"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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: metaname
in: path
required: true
type: string
+ example: __METANAME__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
consumes:
- application/json
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.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: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-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/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-ver"
+ $ref: "#/getDefinitions/model-ver"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
tags:
- ServiceDesignAndCreation
summary: create or update an existing model-ver
- description: create or update an existing model-ver
+ description: |
+ Create or update an existing model-ver.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
consumes:
- application/json
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: body
in: body
- description: model-ver object that needs to be created or updated
+ description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
required: true
schema:
$ref: "#/definitions/model-ver"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-ver
+ description: |
+ Update an existing model-ver
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
+ 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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: body
+ in: body
+ description: model-ver object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-ver"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-version-id
in: path
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ example: __MODEL-VERSION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-vers"
+ $ref: "#/getDefinitions/model-vers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-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/v11/ServiceDesignAndCreationModelsModel.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
/service-design-and-creation/models/model/{model-invariant-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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-ID__
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
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 the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-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/v11/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-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: body
+ in: body
+ description: model object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model"
delete:
tags:
- ServiceDesignAndCreation
description: Unique identifier corresponding to the main definition of a model in ASDC
required: true
type: string
+ example: __MODEL-INVARIANT-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/).
/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:
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/v11/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
+ example: __RELATED-LOOKUP-UUID__
- name: named-query-name
in: query
required: false
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/v11/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 created or 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
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: named-query-name
in: query
required: false
"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
+ example: __PROPERTY-CONSTRAINT-UUID__
- name: named-query-name
in: query
required: false
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/v11/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 created or 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
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: named-query-name
in: query
required: false
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/v11/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
+ example: __NAMED-QUERY-ELEMENT-UUID__
- name: named-query-name
in: query
required: false
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/v11/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 created or 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
+ example: __NAMED-QUERY-UUID__
- name: named-query-name
in: query
required: false
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/v11/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
+ example: __NAMED-QUERY-UUID__
- name: named-query-name
in: query
required: false
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/v11/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 created or 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/).
/network/logical-links/logical-link/{link-name}/relationship-list/relationship:
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/v11/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
+ example: __LINK-NAME__
- name: model-invariant-id
in: query
description: the ASDC model id for this resource or service model.
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/v11/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 created or 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/).
/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:
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/v11/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/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
required: true
schema:
$ref: "#/definitions/class-of-service"
+ patch:
+ tags:
+ - Network
+ 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
+ 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: 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/class-of-service"
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: cos
in: path
description: unique identifier of probe
required: true
type: string
+ example: __COS__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/classes-of-service"
+ $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
+ 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}/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: 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/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.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__
/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/v11/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 created or 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__
/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/v11/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/v11/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 created or 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__
/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/v11/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/v11/NetworkSitePairSetsSitePairSet.json)
required: true
schema:
$ref: "#/definitions/site-pair-set"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing site-pair-set
- description: delete an existing site-pair-set
- operationId: deleteNetworkSitePairSetsSitePairSet
+ 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
description: Unique id of site pair set.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/site-pair-sets:
- get:
- tags:
- - Network
- summary: returns site-pair-sets
- description: returns site-pair-sets
- operationId: getNetworkSitePairSets
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/site-pair-sets"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
- 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
- - name: global-route-target
- in: path
- description: Number used to identify an RT, globally unique in the network
- required: true
- type: string
- - name: route-target-role
- in: path
- description: Role assigned to this route target
- required: true
- type: string
+ example: __SITE-PAIR-SET-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: site-pair-set object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/site-pair-set"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
+ summary: delete an existing site-pair-set
+ description: delete an existing site-pair-set
+ operationId: deleteNetworkSitePairSetsSitePairSet
consumes:
- application/json
- application/xml
"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
- - name: global-route-target
+ - name: site-pair-set-id
in: path
- description: Number used to identify an RT, globally unique in the network
+ description: Unique id of site pair set.
required: true
type: string
- - name: route-target-role
- in: path
- description: Role assigned to this route target
+ example: __SITE-PAIR-SET-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
+ /network/site-pair-sets:
get:
tags:
- Network
- summary: returns route-target
- description: returns route-target
- operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: returns site-pair-sets
+ description: returns site-pair-sets
+ operationId: getNetworkSitePairSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-target"
+ $ref: "#/getDefinitions/site-pair-sets"
"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
- - name: global-route-target
- in: path
- description: Number used to identify an RT, globally unique in the network
- required: true
- type: string
- - name: route-target-role
- in: path
- description: Role assigned to this route target
- required: true
- type: string
- - name: vpn-name
- in: query
- description: VPN Name
- required: false
- type: string
- - name: vpn-type
- in: query
- description: Type of the vpn, should be taken from enumerated/valid values
- required: false
- type: string
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
put:
tags:
- Network
- summary: create or update an existing route-target
- description: create or update an existing route-target
- operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
- name: global-route-target
in: path
description: Number used to identify an RT, globally unique in the network
required: true
type: string
+ example: __GLOBAL-ROUTE-TARGET__
- name: route-target-role
in: path
description: Role assigned to this route target
required: true
type: string
+ example: __ROUTE-TARGET-ROLE__
- name: body
in: body
- description: route-target 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/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
required: true
schema:
- $ref: "#/definitions/route-target"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing route-target
- description: delete an existing route-target
- operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
consumes:
- application/json
- application/xml
description: VPN ID, globally unique within A&AI
required: true
type: string
+ example: __VPN-ID__
- name: global-route-target
in: path
description: Number used to identify an RT, globally unique in the network
required: true
type: string
+ example: __GLOBAL-ROUTE-TARGET__
- name: route-target-role
in: path
description: Role assigned to this route target
required: true
type: string
+ example: __ROUTE-TARGET-ROLE__
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
+ get:
+ tags:
+ - Network
+ summary: returns route-target
+ description: returns route-target
+ operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/route-target"
+ "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: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing route-target
+ description: |
+ Create or update an existing route-target.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ 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: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: body
+ in: body
+ description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
+ required: true
+ schema:
+ $ref: "#/definitions/route-target"
+ patch:
+ tags:
+ - Network
+ summary: update an existing route-target
+ description: |
+ Update an existing route-target
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ 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: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: body
+ in: body
+ description: route-target object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/route-target"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing route-target
+ description: delete an existing route-target
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ 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: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/route-targets"
+ $ref: "#/getDefinitions/route-targets"
"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
+ example: __VPN-ID__
- name: vpn-name
in: query
description: VPN Name
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/v11/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
+ example: __VPN-ID__
- name: vpn-name
in: query
description: VPN Name
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/v11/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 created or 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/).
/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
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/v11/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/v11/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}/sriov-pfs/sriov-pf/{pf-pci-id}/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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-pf"
+ $ref: "#/getDefinitions/sriov-pf"
"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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
tags:
- Network
summary: create or update an existing sriov-pf
- description: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: body
in: body
- description: sriov-pf object that needs to be created or updated
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
required: true
schema:
$ref: "#/definitions/sriov-pf"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing sriov-pf
- description: delete an existing sriov-pf
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ summary: update an existing sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated.
required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
- get:
- tags:
- - Network
- summary: returns sriov-pfs
- description: returns sriov-pfs
- operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
schema:
- $ref: "#/definitions/sriov-pfs"
- "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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- 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
- /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:
+ $ref: "#/patchDefinitions/sriov-pf"
+ delete:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
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
- - name: interface-name
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: Name given to the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
+ example: __PF-PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
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:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
"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: interface-name
- in: path
- description: Name given to the interface
- required: true
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
- required: true
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ 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__
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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-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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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-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.
+ 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: 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 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
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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-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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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-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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ 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: l3-interface-ipv6-address-list object that needs to be created or 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: 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
+ example: __VLAN-INTERFACE__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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
+ example: __PCI-ID__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
"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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __EQUIPMENT-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: 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/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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: 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.
+ 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: 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: 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/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/l3-interface-ipv6-address-list"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ 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
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
- get:
- tags:
- - Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/vlan"
- "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 link aggregate 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: 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: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
- put:
- tags:
- - Network
- summary: create or update an existing vlan
- description: create or update an existing vlan
- operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
- 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 link aggregate 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
+ 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.
required: true
schema:
- $ref: "#/definitions/vlan"
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
- summary: delete an existing vlan
- description: delete an existing vlan
- operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ 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: 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: 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: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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 created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ 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: 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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
+ example: __PCI-ID__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
"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
+ example: __INTERFACE-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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
+ example: __EQUIPMENT-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
"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
+ example: __EQUIPMENT-NAME__
- name: prov-status
in: query
description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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/v11/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 created or 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/).
/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
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/v11/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/v11/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 created or 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/).
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/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__
- 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/v11/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
+ example: __CVLAN-TAG__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-ID__
- name: vnf-name
in: query
description: Name of VNF.
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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.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__
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/port-group"
+ $ref: "#/getDefinitions/port-group"
"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: vnf-name
in: query
description: Name of VNF.
tags:
- Network
summary: create or update an existing port-group
- description: 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
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 created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
required: true
schema:
$ref: "#/definitions/port-group"
+ patch:
+ tags:
+ - Network
+ 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
+ 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: body
+ in: body
+ description: port-group object that needs to be created or updated.
+ required: true
+ schema:
+ $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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-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/v11/NetworkVcesVceLicensesLicense.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: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/license"
+ $ref: "#/getDefinitions/license"
"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: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: vnf-name
in: query
description: Name of VNF.
tags:
- Network
summary: create or update an existing license
- description: create or update an existing license
+ description: |
+ Create or update an existing license.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkVcesVceLicensesLicense
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: body
in: body
- description: license object that needs to be created or updated
+ description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
required: true
schema:
$ref: "#/definitions/license"
+ patch:
+ tags:
+ - Network
+ summary: update an existing license
+ description: |
+ Update an existing license
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVceLicensesLicense
+ 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: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/license"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/licenses"
+ $ref: "#/getDefinitions/licenses"
"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: vnf-name
in: query
description: Name of VNF.
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-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/v11/NetworkVcesVceEntitlementsEntitlement.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: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlement"
+ $ref: "#/getDefinitions/entitlement"
"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: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: vnf-name
in: query
description: Name of VNF.
tags:
- Network
summary: create or update an existing entitlement
- description: create or update an existing entitlement
+ description: |
+ Create or update an existing entitlement.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: body
in: body
- description: entitlement object that needs to be created or updated
+ description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
required: true
schema:
$ref: "#/definitions/entitlement"
+ patch:
+ tags:
+ - Network
+ summary: update an existing entitlement
+ description: |
+ Update an existing entitlement
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVceEntitlementsEntitlement
+ 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: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/entitlement"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlements"
+ $ref: "#/getDefinitions/entitlements"
"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: vnf-name
in: query
description: Name of VNF.
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/v11/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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/).
/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
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/v11/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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
put:
tags:
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-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/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
/network/vnfcs/vnfc/{vnfc-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 vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: l3-interface-ipv4-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: nfc-naming-code
in: query
description: Short code that is used in naming instances of the item being modeled
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: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
consumes:
- application/json
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-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/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.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: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ 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: 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
delete:
tags:
- Network
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-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 vnfc.
required: true
type: string
+ example: __VNFC-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/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
/network/vnfcs/vnfc/{vnfc-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 vnfc.
required: true
type: string
+ example: __VNFC-NAME__
- name: l3-interface-ipv6-address
in: path
description: IP address
required: true
type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: nfc-naming-code
in: query
description: Short code that is used in naming instances of the item being modeled
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: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
consumes:
- application/json
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-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/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.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: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ 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: 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.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
description: Unique ID of vnfc.
required: true
type: string
+ example: __VNFC-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/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
+ example: __VNFC-NAME__
- name: nfc-naming-code
in: query
description: Short code that is used in naming instances of the item being modeled
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/v11/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 created or 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/).
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/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__
- name: host-route-id
in: path
description: host-route id
required: true
type: string
+ example: __HOST-ROUTE-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/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.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__
- name: host-route-id
in: path
description: host-route id
required: true
type: string
+ example: __HOST-ROUTE-ID__
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/host-route"
+ $ref: "#/getDefinitions/host-route"
"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
+ example: __SUBNET-ID__
- name: host-route-id
in: path
description: host-route id
required: true
type: string
+ example: __HOST-ROUTE-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
tags:
- Network
summary: create or update an existing host-route
- description: create or update an existing host-route
+ description: |
+ Create or update an existing host-route.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
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: host-route-id
in: path
description: host-route id
required: true
type: string
+ example: __HOST-ROUTE-ID__
- name: body
in: body
- description: host-route object that needs to be created or updated
+ description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
required: true
schema:
$ref: "#/definitions/host-route"
+ patch:
+ tags:
+ - Network
+ summary: update an existing host-route
+ description: |
+ Update an existing host-route
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ 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: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: body
+ in: body
+ description: host-route object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/host-route"
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: host-route-id
in: path
description: host-route id
required: true
type: string
+ example: __HOST-ROUTE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/host-routes"
+ $ref: "#/getDefinitions/host-routes"
"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
+ example: __SUBNET-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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
+ example: __SUBNET-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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 created or 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
+ example: __NETWORK-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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
+ example: __VLAN-ID-INNER__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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 created or 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
+ example: __NETWORK-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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
+ example: __SEGMENTATION-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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 created or 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
+ example: __NETWORK-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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
+ example: __NETWORK-ID__
- name: network-name
in: query
description: Name of the network, governed by some naming convention..
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/v11/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 created or 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/).
/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
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/v11/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
+ example: __NETWORK-POLICY-ID__
- name: network-policy-fqdn
in: query
description: Contrail FQDN for the policy
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/v11/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 created or 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/).
/network/generic-vnfs/generic-vnf/{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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __VLAN-INTERFACE__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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
+ example: __PCI-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: 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/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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: 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.
+ 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: 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: 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/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ 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: 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.
+ 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: 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
+ example: __VLAN-INTERFACE__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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
+ example: __PCI-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ 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: body
+ in: body
+ description: sriov-vf object that needs to be created or 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 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 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: vnf-name
in: query
description: Name of VNF.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
"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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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
+ example: __VF-MODULE-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-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/v11/NetworkGenericVnfsGenericVnfLicensesLicense.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: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/license"
+ $ref: "#/getDefinitions/license"
"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: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: vnf-name
in: query
description: Name of VNF.
tags:
- Network
summary: create or update an existing license
- description: create or update an existing license
+ description: |
+ Create or update an existing license.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: body
in: body
- description: license object that needs to be created or updated
+ description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
required: true
schema:
$ref: "#/definitions/license"
+ patch:
+ tags:
+ - Network
+ summary: update an existing license
+ description: |
+ Update an existing license
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
+ 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: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/license"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of a license resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/licenses"
+ $ref: "#/getDefinitions/licenses"
"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: vnf-name
in: query
description: Name of VNF.
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-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/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.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: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlement"
+ $ref: "#/getDefinitions/entitlement"
"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: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: vnf-name
in: query
description: Name of VNF.
tags:
- Network
summary: create or update an existing entitlement
- description: create or update an existing entitlement
+ description: |
+ Create or update an existing entitlement.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
consumes:
- application/json
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: body
in: body
- description: entitlement object that needs to be created or updated
+ description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
required: true
schema:
$ref: "#/definitions/entitlement"
+ patch:
+ tags:
+ - Network
+ summary: update an existing entitlement
+ description: |
+ Update an existing entitlement
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
+ 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: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/entitlement"
delete:
tags:
- Network
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
+ example: __VNF-ID__
- name: group-uuid
in: path
description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
+ example: __GROUP-UUID__
- name: resource-uuid
in: path
description: Unique ID of an entitlement resource.
required: true
type: string
+ example: __RESOURCE-UUID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlements"
+ $ref: "#/getDefinitions/entitlements"
"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: vnf-name
in: query
description: Name of VNF.
"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
+ example: __VNF-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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"
+ $ref: "#/getDefinitions/generic-vnfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/network/lag-links/lag-link/{link-name}/relationship-list/relationship:
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
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
required: true
schema:
$ref: "#/definitions/relationship"
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/v11/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 created or 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/).
/network/newvces/newvce/{vnf-id2}/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: 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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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
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: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
- 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
- - 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 created or 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: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
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: l3-interface-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
- get:
- tags:
- - Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- 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: 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
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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-key
- 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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
put:
tags:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
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
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ 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:
- Network
- summary: returns vlan
- description: returns vlan
- operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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 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: 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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-key
+ 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.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few 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/v11/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:
+ - 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.
+ 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: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ 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: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ 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: 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: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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
+ example: __PCI-ID__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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
+ example: __VNF-ID2__
- name: vnf-name
in: query
description: Name of VNF.
"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
+ example: __VNF-ID2__
- name: vnf-name
in: query
description: Name of VNF.
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/v11/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 created or 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/).
/network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
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/v11/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/v11/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}/sriov-pfs/sriov-pf/{pf-pci-id}/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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-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/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/sriov-pf"
+ $ref: "#/getDefinitions/sriov-pf"
"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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
tags:
- Network
summary: create or update an existing sriov-pf
- description: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
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: pf-pci-id
in: path
description: Identifier for the sriov-pf
required: true
type: string
+ example: __PF-PCI-ID__
- name: body
in: body
- description: sriov-pf object that needs to be created or updated
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
required: true
schema:
$ref: "#/definitions/sriov-pf"
- delete:
+ patch:
tags:
- Network
- summary: delete an existing sriov-pf
- description: delete an existing sriov-pf
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
+ summary: update an existing sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
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: pf-pci-id
in: path
description: Identifier for the sriov-pf
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}/sriov-pfs:
- get:
- tags:
- - Network
- summary: returns sriov-pfs
- description: returns sriov-pfs
- operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/sriov-pfs"
- "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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- 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
- /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- 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
+ example: __PF-PCI-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: sriov-pf object that needs to be created or updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/sriov-pf"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
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
- - name: interface-name
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
in: path
- description: Name given to the interface
+ description: Identifier for the sriov-pf
required: true
type: string
- - name: vlan-interface
- in: path
- description: String that identifies the interface
+ example: __PF-PCI-ID__
+ - 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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
- put:
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
"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: 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
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
type: string
- - name: l3-interface-ipv4-address
- in: path
- description: IP address
- required: true
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ put:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ 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__
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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-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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ 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-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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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-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.
+ 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: 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 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
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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-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}/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 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: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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-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/v11/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 created or 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: 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 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: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
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: 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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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
+ example: __PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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/v11/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
"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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __PNF-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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-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/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ 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
- - 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 created or updated.
required: true
- type: string
- /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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
- - 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
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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-ipv6-address
in: path
description: IP address
required: true
type: string
- /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:
+ 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/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
tags:
- Network
- summary: returns l3-interface-ipv6-address-list
- description: returns l3-interface-ipv6-address-list
- operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
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:
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: inv-status
- in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: interface-role
- in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- 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-key
- 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:
+ 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:
- Network
- summary: create or update an existing l3-interface-ipv6-address-list
- description: create or update an existing l3-interface-ipv6-address-list
- operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
- consumes:
- - application/json
- - application/xml
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ 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-key
+ 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.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few 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
+ - 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 created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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 created or 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
+ example: __VLAN-INTERFACE__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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
+ example: __PCI-ID__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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/v11/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
+ example: __L3-INTERFACE-IPV4-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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-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/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ 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
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
- 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 link aggregate interface
- required: true
- type: string
- - name: interface-name
- in: path
- description: Name given to 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 created or 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: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ 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__
/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
+ example: __L3-INTERFACE-IPV6-ADDRESS__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
"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
+ example: __INTERFACE-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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
+ example: __PNF-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
"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
+ example: __PNF-NAME__
- name: inv-status
in: query
description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
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/v11/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 created or 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/).
/network/physical-links/physical-link/{link-name}/relationship-list/relationship:
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/v11/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
+ example: __LINK-NAME__
- name: circuit-id
in: query
description: Circuit it
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/v11/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 created or 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/).
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
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/v11/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/v11/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/v11/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 created or 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__
/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/v11/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 created or 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/).
/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
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/v11/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
+ example: __ROUTE-TABLE-REFERENCE-ID__
- name: route-table-reference-fqdn
in: query
description: FQDN entry in the route table.
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/v11/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 created or 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/).
/network/instance-groups/instance-group/{id}/relationship-list/relationship:
description: Instance Group ID, UUID assigned to this instance.
required: true
type: string
+ example: __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/v11/NetworkInstanceGroupsInstanceGroup.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Instance Group ID, UUID assigned to this instance.
required: true
type: string
+ example: __ID__
/network/instance-groups/instance-group/{id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/instance-group"
+ $ref: "#/getDefinitions/instance-group"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Instance Group ID, UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: description
in: query
description: Descriptive text to help identify the usage of this instance-group
tags:
- Network
summary: create or update an existing instance-group
- description: create or update an existing instance-group
+ description: |
+ Create or update an existing instance-group.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
consumes:
- application/json
description: Instance Group ID, UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: body
in: body
- description: instance-group object that needs to be created or updated
+ description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
required: true
schema:
$ref: "#/definitions/instance-group"
+ patch:
+ tags:
+ - Network
+ summary: update an existing instance-group
+ description: |
+ Update an existing instance-group
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkInstanceGroupsInstanceGroup
+ 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: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: instance-group object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/instance-group"
delete:
tags:
- Network
description: Instance Group ID, UUID assigned to this instance.
required: true
type: string
+ example: __ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/instance-groups"
+ $ref: "#/getDefinitions/instance-groups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
/network/zones/zone/{zone-id}/relationship-list/relationship:
description: Code assigned by AIC to the zone
required: true
type: string
+ example: __ZONE-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/v11/NetworkZonesZone.json)
required: true
schema:
$ref: "#/definitions/relationship"
description: Code assigned by AIC to the zone
required: true
type: string
+ example: __ZONE-ID__
/network/zones/zone/{zone-id}:
get:
tags:
"200":
description: successful operation
schema:
- $ref: "#/definitions/zone"
+ $ref: "#/getDefinitions/zone"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Code assigned by AIC to the zone
required: true
type: string
+ example: __ZONE-ID__
- name: design-type
in: query
description: Design of zone [Medium/Large?]
tags:
- Network
summary: create or update an existing zone
- description: create or update an existing zone
+ description: |
+ Create or update an existing zone.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
operationId: createOrUpdateNetworkZonesZone
consumes:
- application/json
description: Code assigned by AIC to the zone
required: true
type: string
+ example: __ZONE-ID__
- name: body
in: body
- description: zone object that needs to be created or updated
+ description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
required: true
schema:
$ref: "#/definitions/zone"
+ patch:
+ tags:
+ - Network
+ summary: update an existing zone
+ description: |
+ Update an existing zone
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkZonesZone
+ 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: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: body
+ in: body
+ description: zone object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/zone"
delete:
tags:
- Network
description: Code assigned by AIC to the zone
required: true
type: string
+ example: __ZONE-ID__
- name: resource-version
in: query
description: resource-version for concurrency
"200":
description: successful operation
schema:
- $ref: "#/definitions/zones"
+ $ref: "#/getDefinitions/zones"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
+ /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVipIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv4-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
+ example: __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/v11/NetworkConfigurationsConfiguration.json)
required: true
schema:
$ref: "#/definitions/relationship"
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVipIpv4AddressListRelationshipListRelationship
+ operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv4-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- /network/vip-ipv4-address-list/{vip-ipv4-address}:
+ example: __CONFIGURATION-ID__
+ /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
get:
tags:
- Network
- summary: returns vip-ipv4-address-list
- description: returns vip-ipv4-address-list
- operationId: getNetworkVipIpv4AddressList
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vip-ipv4-address-list"
+ $ref: "#/getDefinitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv4-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: model-invariant-id
in: query
- description: Neutron network id of the interface that address belongs to
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: neutron-subnet-id
+ - name: model-version-id
in: query
- description: Neutron id of subnet that address belongs to
+ description: the ASDC model version for this resource or service model.
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing vip-ipv4-address-list
- description: create or update an existing vip-ipv4-address-list
- operationId: createOrUpdateNetworkVipIpv4AddressList
+ 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: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv4-address
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: metaname
in: path
- description: IP address
required: true
type: string
+ example: __METANAME__
- name: body
in: body
- description: vip-ipv4-address-list 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/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)
required: true
schema:
- $ref: "#/definitions/vip-ipv4-address-list"
- delete:
+ $ref: "#/definitions/metadatum"
+ patch:
tags:
- Network
- summary: delete an existing vip-ipv4-address-list
- description: delete an existing vip-ipv4-address-list
- operationId: deleteNetworkVipIpv4AddressList
+ 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: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv4-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
required: true
type: string
- /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
- put:
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVipIpv6AddressListRelationshipListRelationship
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv6-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/configurations/configuration/{configuration-id}/metadata:
+ get:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVipIpv6AddressListRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns metadata
+ description: returns metadata
+ operationId: getNetworkConfigurationsConfigurationMetadata
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv6-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- /network/vip-ipv6-address-list/{vip-ipv6-address}:
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ /network/configurations/configuration/{configuration-id}:
get:
tags:
- Network
- summary: returns vip-ipv6-address-list
- description: returns vip-ipv6-address-list
- operationId: getNetworkVipIpv6AddressList
+ summary: returns configuration
+ description: returns configuration
+ operationId: getNetworkConfigurationsConfiguration
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vip-ipv6-address-list"
+ $ref: "#/getDefinitions/configuration"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv6-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
in: query
- description: Neutron network id of the interface that address belongs to
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: neutron-subnet-id
+ - name: model-version-id
in: query
- description: Neutron id of subnet that address belongs to
+ description: the ASDC model version for this resource or service model.
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing vip-ipv6-address-list
- description: create or update an existing vip-ipv6-address-list
- operationId: createOrUpdateNetworkVipIpv6AddressList
+ summary: create or update an existing configuration
+ description: |
+ Create or update an existing configuration.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkConfigurationsConfiguration
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv6-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
+ example: __CONFIGURATION-ID__
- name: body
in: body
- description: vip-ipv6-address-list object that needs to be created or updated
+ description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
required: true
schema:
- $ref: "#/definitions/vip-ipv6-address-list"
+ $ref: "#/definitions/configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing configuration
+ description: |
+ Update an existing configuration
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkConfigurationsConfiguration
+ 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: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: configuration object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/configuration"
delete:
tags:
- Network
- summary: delete an existing vip-ipv6-address-list
- description: delete an existing vip-ipv6-address-list
- operationId: deleteNetworkVipIpv6AddressList
+ summary: delete an existing configuration
+ description: delete an existing configuration
+ operationId: deleteNetworkConfigurationsConfiguration
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vip-ipv6-address
+ - name: configuration-id
in: path
- description: IP address
+ description: UUID assigned to configuration.
required: true
type: string
+ example: __CONFIGURATION-ID__
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
+ /network/configurations:
+ get:
+ tags:
+ - Network
+ summary: returns configurations
+ description: returns configurations
+ operationId: getNetworkConfigurations
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/configurations"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
definitions:
- 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"
- actions:
- description: |
- APIs that are more action related than REST (e.g., notify, update).
- properties:
- update:
- type: object
- $ref: "#/definitions/update"
- notify:
- type: object
- $ref: "#/definitions/notify"
- 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.
- related-to-property:
+ aai-internal:
properties:
- property-key:
+ property-name:
type: string
- description: Key part of a key/value pair
property-value:
type: string
- description: Value part of a key/value pair
- relationship:
+ action:
properties:
- related-to:
- type: string
- description: A keyword provided by A&AI to indicate type of node.
- related-link:
+ action-type:
type: string
- description: URL to the object in A&AI.
- relationship-data:
- type: array
- items:
- $ref: "#/definitions/relationship-data"
- related-to-property:
- type: array
- items:
- $ref: "#/definitions/related-to-property"
- relationship-list:
- properties:
- relationship:
+ action-data:
type: array
items:
- $ref: "#/definitions/relationship"
- ctag-pool:
- description: |
- A collection of C tags (vlan tags) grouped for a specific purpose.
- ###### Related Nodes
- - TO availability-zone (Many2Many)
- - FROM complex (is composed of ctag-pool)
- - FROM vpls-pe
- - FROM generic-vnf
- required:
- - target-pe
- - availability-zone-name
- - ctag-pool-purpose
+ $ref: "#/definitions/action-data"
+ action-data:
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:
+ property-name:
type: string
- description: Comma separated list of ctags
- resource-version:
+ property-value:
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-pools:
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
properties:
- ctag-pool:
- type: array
- items:
- $ref: "#/definitions/ctag-pool"
- complex:
+ update:
+ type: object
+ $ref: "#/definitions/update"
+ notify:
+ type: object
+ $ref: "#/definitions/notify"
+ allotted-resource:
description: |
- Collection of physical locations that can house cloud-regions.
+ Represents a slice or partial piece of a resource that gets separately allotted
###### 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
- - FROM zone
- - FROM generic-vnf
+ - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
required:
- - physical-location-id
- - physical-location-type
- - street1
- - city
- - postal-code
- - country
- - region
+ - id
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:
+ id:
type: string
- street2:
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
type: string
- city:
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
type: string
- state:
+ description: Link back to more information in the controller
+ model-invariant-id:
type: string
- postal-code:
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
type: string
- country:
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
type: string
- region:
+ description: the ASDC model version for this resource or service model.
+ resource-version:
type: string
- latitude:
+ description: Concurrency value
+ orchestration-status:
type: string
- longitude:
+ description: Orchestration status
+ operational-status:
type: string
- elevation:
+ description: Indicator for whether the resource is considered operational
+ type:
type: string
- lata:
+ description: Generic description of the type of allotted resource.
+ role:
type: string
- ctag-pools:
+ description: role in the network that this resource will be providing.
+ tunnel-xconnects:
type: array
items:
- $ref: "#/definitions/ctag-pool"
+ $ref: "#/definitions/tunnel-xconnect"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- complexes:
+ allotted-resources:
description: |
- Collection of physical locations that can house cloud-regions.
+ This object is used to store slices of services being offered
properties:
- complex:
+ allotted-resource:
type: array
items:
- $ref: "#/definitions/complex"
- volume-group:
+ $ref: "#/definitions/allotted-resource"
+ availability-zone:
description: |
- Persistent block-level storage.
+ Availability zone, a collection of compute hosts/pservers
###### Related Nodes
- - TO complex (Many2Many)
- - TO tenant (Many2Many)
- - FROM cloud-region (is composed of volume-group)
- - FROM vf-module
- - FROM generic-vnf
+ - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
required:
- - volume-group-id
- - volume-group-name
- - vnf-type
+ - availability-zone-name
+ - hypervisor-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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- orchestration-status:
+ availability-zone-name:
type: string
- description: Orchestration status of this volume-group
- model-customization-id:
+ description: Name of the availability zone. Unique across a cloud region
+ hypervisor-type:
type: string
- description: captures the id of all the configuration used to customize the resource for the service.
- vf-module-model-customization-id:
+ description: Type of hypervisor. Source of truth should define valid values.
+ operational-status:
type: string
- description: helps relate the volume group to the vf-module whose components will require the volume group
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- volume-groups:
+ availability-zones:
description: |
- Collection of persistent block-level storage.
+ Collection of availability zones
properties:
- volume-group:
+ availability-zone:
type: array
items:
- $ref: "#/definitions/volume-group"
- volume:
+ $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"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/definitions/project"
+ class-of-service:
description: |
- Ephemeral Block storage volume.
###### Related Nodes
- - FROM vserver (is composed of volume)
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
required:
- - volume-id
- - volume-selflink
+ - cos
properties:
- volume-id:
+ cos:
type: string
- description: Unique ID of block storage volume relative to the vserver.
- volume-selflink:
+ description: unique identifier of probe
+ probe-id:
type: string
- description: URL to endpoint where AAI can get more details
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- volumes:
+ classes-of-service:
description: |
- Collection of ephemeral Block storage volumes.
+ class-of-service of probe
properties:
- volume:
+ class-of-service:
type: array
items:
- $ref: "#/definitions/volume"
- l3-interface-ipv4-address-list:
+ $ref: "#/definitions/class-of-service"
+ cloud-infrastructure:
description: |
- IPv4 Address Range
- ###### Related Nodes
- - TO instance-group (Many2Many)
- - TO l3-network (Many2Many)
- - TO subnet (Many2Many)
- - TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
- - FROM l-interface (is composed of l3-interface-ipv4-address-list)
- - FROM vlan (is composed of l3-interface-ipv4-address-list)
- required:
- - l3-interface-ipv4-address
+ Namespace for cloud infrastructure.
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:
+ complexes:
type: array
items:
- $ref: "#/definitions/relationship"
- l3-interface-ipv6-address-list:
- description: |
- IPv6 Address Range
- ###### Related Nodes
- - TO instance-group (Many2Many)
- - TO l3-network (Many2Many)
- - TO subnet (Many2Many)
- - TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
- - FROM l-interface (is composed of l3-interface-ipv6-address-list)
- - FROM vlan (is composed of l3-interface-ipv6-address-list)
- 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:
+ $ref: "#/definitions/complex"
+ cloud-regions:
type: array
items:
- $ref: "#/definitions/relationship"
- vlan:
+ $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: |
- Definition of vlan
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### 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 (Many2Many)
- - FROM l-interface (is composed of vlan)
- - FROM service-instance
- - FROM allotted-resource
+ - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
- - vlan-interface
- - in-maint
- - is-ip-unnumbered
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
properties:
- vlan-interface:
+ cloud-owner:
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:
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- speed-value:
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
type: string
- description: Captures the numeric part of the speed
- speed-units:
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
type: string
- description: Captures the units corresponding to the speed
- vlan-description:
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
type: string
- description: Used to describe (the service associated with) the vlan
- backdoor-connection:
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
type: string
- description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
- vpn-key:
+ description: URL of the keystone identity service
+ cloud-zone:
type: string
- description: This indicates the customers VPN ID associated with this vlan
- orchestration-status:
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
type: string
- description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
- in-maint:
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
type: boolean
- prov-status:
+ cloud-extra-info:
type: string
- description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
- is-ip-unnumbered:
- type: boolean
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
+ 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"
- l3-interface-ipv4-address-list:
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ vip-ipv4-address-list:
type: array
items:
- $ref: "#/definitions/l3-interface-ipv4-address-list"
- l3-interface-ipv6-address-list:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
type: array
items:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- vlans:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ cloud-regions:
properties:
- vlan:
+ cloud-region:
type: array
items:
- $ref: "#/definitions/vlan"
- sriov-vf:
+ $ref: "#/definitions/cloud-region"
+ complex:
description: |
- SR-IOV Virtual Function (not to be confused with virtual network function)
+ Collection of physical locations that can house cloud-regions.
###### Related Nodes
- - TO sriov-pf (Many2One)
- - FROM l-interface (is composed of sriov-vf)
+ - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
required:
- - pci-id
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
properties:
- pci-id:
- type: string
- description: PCI ID used to identify the sriov-vf
- vf-vlan-filter:
+ physical-location-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: Unique identifier for physical location, e.g., CLLI
+ data-center-code:
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: Data center code which can be an alternate way to identify a complex
+ complex-name:
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: Gamma complex name for LCP instance.
+ identity-url:
type: string
- description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
+ 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.
- neutron-network-id:
+ physical-location-type:
type: string
- description: Neutron network id of the interface
+ 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: "#/definitions/ctag-pool"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- sriov-vfs:
+ complexes:
description: |
- Collection of SR-IOV Virtual Functions.
+ Collection of physical locations that can house cloud-regions.
properties:
- sriov-vf:
+ complex:
type: array
items:
- $ref: "#/definitions/sriov-vf"
- l-interface:
+ $ref: "#/definitions/complex"
+ configuration:
description: |
- Logical interfaces, e.g., a vnic.
+ Port Mirror Configuration.
###### Related Nodes
- - TO instance-group (Many2Many)
- - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
- - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
- - TO l-interface (comprises l-interface, One2Many)
- - TO logical-link (Many2Many)
- - TO vlan (comprises l-interface, Many2Many)
- - TO sriov-vf (comprises l-interface, One2One)
- - FROM generic-vnf (is composed of l-interface)
- - FROM lag-interface (is composed of l-interface)
- - FROM newvce (is composed of l-interface)
- - FROM p-interface (is composed of l-interface)
- - FROM vserver (is composed of l-interface)
- - FROM allotted-resource
- - FROM l-interface (is composed of l-interface)
+ - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
required:
- - interface-name
- - is-port-mirrored
- - in-maint
- - is-ip-unnumbered
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
properties:
- interface-name:
+ configuration-id:
type: string
- description: Name given to the interface
- interface-role:
+ description: UUID assigned to configuration.
+ management-option:
type: string
- description: E.g., CUSTOMER, UPLINK, etc.
- v6-wan-link-ip:
+ 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: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
- selflink:
+ description: Name of the configuration.
+ configuration-type:
type: string
- description: URL to endpoint where AAI can get more details
- interface-id:
+ description: port-mirroring-configuration.
+ configuration-sub-type:
type: string
- description: ID of interface
- macaddr:
+ description: vprobe, pprobe.
+ model-invariant-id:
type: string
- description: MAC address for the interface
- network-name:
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
type: string
- description: Name of the network
- management-option:
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
type: string
- description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
- interface-description:
+ description: Orchestration status of the configuration.
+ operational-status:
type: string
- description: Human friendly text regarding this interface.
- is-port-mirrored:
- type: boolean
- resource-version:
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- in-maint:
- type: boolean
- prov-status:
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
type: string
- description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
- is-ip-unnumbered:
- type: boolean
- allowed-address-pairs:
+ description: id of the configuration used to customize the resource
+ resource-version:
type: string
- description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
- vlans:
- type: array
- items:
- $ref: "#/definitions/vlan"
- sriov-vfs:
- type: array
- items:
- $ref: "#/definitions/sriov-vf"
- l-interfaces:
- type: array
- items:
- $ref: "#/definitions/l-interface"
+ 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:
+ metadata:
type: array
- items:
- $ref: "#/definitions/l3-interface-ipv6-address-list"
- l-interfaces:
+ items:
+ $ref: "#/definitions/metadatum"
+ configurations:
description: |
- Collection of logical interfaces.
+ Collection of configurations
properties:
- l-interface:
+ configuration:
type: array
items:
- $ref: "#/definitions/l-interface"
- vserver:
+ $ref: "#/definitions/configuration"
+ connector:
description: |
- Virtual Servers, aka virtual machine or VM.
+ Collection of resource instances used to connect a variety of disparate inventory widgets
###### 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
+ - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
required:
- - vserver-id
- - vserver-name
- - vserver-selflink
- - in-maint
- - is-closed-loop-disabled
+ - resource-instance-id
properties:
- vserver-id:
+ resource-instance-id:
type: string
- description: Unique identifier for this vserver relative to its tenant
- vserver-name:
+ description: Unique id of resource instance.
+ resource-version:
type: string
- description: Name of vserver
- vserver-name2:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
type: string
- description: Alternative name of vserver
- prov-status:
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- vserver-selflink:
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
type: string
- description: URL to endpoint where AAI can get more details
- in-maint:
- type: boolean
- is-closed-loop-disabled:
- type: boolean
- resource-version:
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- volumes:
- type: array
- items:
- $ref: "#/definitions/volume"
+ 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"
- l-interfaces:
+ metadata:
type: array
items:
- $ref: "#/definitions/l-interface"
- vservers:
+ $ref: "#/definitions/metadatum"
+ connectors:
description: |
- Collection of virtual Servers, aka virtual machines or VMs.
+ Collection of resource instances used to connect a variety of disparate inventory widgets
properties:
- vserver:
+ connector:
type: array
items:
- $ref: "#/definitions/vserver"
- tenant:
+ $ref: "#/definitions/connector"
+ constrained-element-set:
description: |
- Openstack tenant
+ This is how we would capture constraints defining allowed sets of elements.
###### 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
+ - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
required:
- - tenant-id
- - tenant-name
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
properties:
- tenant-id:
+ constrained-element-set-uuid:
type: string
- description: Unique id relative to the cloud-region.
- tenant-name:
+ constraint-type:
type: string
- description: Readable name of tenant
- tenant-context:
+ check-type:
type: string
- description: This field will store the tenant context.
resource-version:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- vservers:
+ element-choice-sets:
type: array
items:
- $ref: "#/definitions/vserver"
+ $ref: "#/definitions/element-choice-set"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- tenants:
- description: |
- Collection of openstack tenants.
+ constrained-element-sets:
properties:
- tenant:
+ constrained-element-set:
type: array
items:
- $ref: "#/definitions/tenant"
- flavor:
+ $ref: "#/definitions/constrained-element-set"
+ ctag-assignment:
description: |
- Openstack flavor.
###### Related Nodes
- - FROM cloud-region (is composed of flavor)
- - FROM vserver
+ - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
required:
- - flavor-id
- - flavor-name
- - flavor-selflink
+ - vlan-id-inner
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:
+ vlan-id-inner:
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
+ format: int64
+ description: id.
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"
- flavors:
- description: |
- Collection of openstack flavors.
+ ctag-assignments:
properties:
- flavor:
+ ctag-assignment:
type: array
items:
- $ref: "#/definitions/flavor"
- group-assignment:
+ $ref: "#/definitions/ctag-assignment"
+ ctag-pool:
description: |
- Openstack group-assignment used to store exclusivity groups (EG).
+ A collection of C tags (vlan tags) grouped for a specific purpose.
###### Related Nodes
- - TO tenant (Many2Many)
- - TO pserver (One2Many)
- - FROM cloud-region (is composed of group-assignment)
+ - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
required:
- - group-id
- - group-type
- - group-name
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
properties:
- group-id:
+ target-pe:
type: string
- description: Group id, expected to be unique across cloud-region.
- group-type:
+ description: The Target provider edge router
+ availability-zone-name:
type: string
- description: Group type - the type of group this instance refers to
- group-name:
+ description: Name of the availability zone
+ ctag-pool-purpose:
type: string
- description: Group name - name assigned to the group
- group-description:
+ description: Describes what the intended purpose of this pool is.
+ ctag-values:
type: string
- description: Group description - description of the group
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- group-assignments:
- description: |
- Collection of openstack group assignments
+ ctag-pools:
properties:
- group-assignment:
+ ctag-pool:
type: array
items:
- $ref: "#/definitions/group-assignment"
- snapshot:
+ $ref: "#/definitions/ctag-pool"
+ customer:
description: |
- Openstack snapshot
+ customer identifiers to provide linkage back to BSS information.
###### Related Nodes
- - FROM cloud-region (is composed of snapshot)
- - FROM vserver
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
required:
- - snapshot-id
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
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:
+ global-customer-id:
type: string
- description: The version of the application.
- snapshot-selflink:
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ subscriber-name:
type: string
- description: URL to endpoint where AAI can get more details
- prev-snapshot-id:
+ description: Subscriber name, an alternate way to retrieve a customer.
+ subscriber-type:
type: string
- description: This field contains the UUID of the previous snapshot (if any).
+ 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: "#/definitions/service-subscription"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- snapshots:
- description: |
- Collection of openstack snapshots
- properties:
- snapshot:
- type: array
- items:
- $ref: "#/definitions/snapshot"
- metadatum:
- description: |
- Key/value pairs
- ###### Related Nodes
- - FROM image (is composed of metadatum)
- - FROM model-ver (is composed of metadatum)
- - FROM service-instance (is composed of metadatum)
- - FROM connector (is composed of metadatum)
- 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.
- metadata:
+ customers:
description: |
- Collection of metadatum (key/value pairs)
+ Collection of customer identifiers to provide linkage back to BSS information.
properties:
- metadatum:
+ customer:
type: array
items:
- $ref: "#/definitions/metadatum"
- image:
- description: |
- Openstack image.
- ###### Related Nodes
- - TO metadatum (comprises image, Many2Many)
- - FROM cloud-region (is composed of image)
- - FROM vserver
+ $ref: "#/definitions/customer"
+ cvlan-tag-entry:
required:
- - image-id
- - image-name
- - image-os-distro
- - image-os-version
- - image-selflink
+ - cvlan-tag
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
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- metadata:
- type: array
- items:
- $ref: "#/definitions/metadatum"
- images:
- description: |
- Collectio of Openstack images.
+ cvlan-tags:
properties:
- image:
+ cvlan-tag-entry:
type: array
items:
- $ref: "#/definitions/image"
+ $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 availability-zone (Many2Many)
- - FROM cloud-region (is composed of dvs-switch)
+ - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
required:
- switch-name
- vcenter-url
type: array
items:
$ref: "#/definitions/dvs-switch"
- oam-network:
+ edge-prop-names:
description: |
- OAM network, to be deprecated shortly. Do not use for new purposes.
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
+ SVC-INFRA:
+ type: string
+ prevent-delete:
+ type: string
+ 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: "#/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 complex (Many2Many)
- - TO service-capability (Many2Many)
- - FROM cloud-region (is composed of oam-network)
+ - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
required:
- - network-uuid
- - network-name
- - cvlan-tag
+ - element-choice-set-uuid
+ - element-choice-set-name
properties:
- network-uuid:
+ element-choice-set-uuid:
type: string
- description: UUID of the network. Unique across a cloud-region
- network-name:
+ element-choice-set-name:
type: string
- description: Name of the network.
- cvlan-tag:
- type: integer
- format: int64
- description: cvlan-id
- ipv4-oam-gateway-address:
+ cardinality:
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.
+ model-elements:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
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.
+ element-choice-sets:
properties:
- oam-network:
+ element-choice-set:
type: array
items:
- $ref: "#/definitions/oam-network"
- availability-zone:
+ $ref: "#/definitions/element-choice-set"
+ entitlement:
description: |
- Availability zone, a collection of compute hosts/pservers
+ Metadata for entitlement group.
###### 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
+ - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
required:
- - availability-zone-name
- - hypervisor-type
+ - group-uuid
+ - resource-uuid
properties:
- availability-zone-name:
- type: string
- description: Name of the availability zone. Unique across a cloud region
- hypervisor-type:
+ group-uuid:
type: string
- description: Type of hypervisor. Source of truth should define valid values.
- operational-status:
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ resource-uuid:
type: string
- description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ description: Unique ID of an entitlement resource.
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"
- availability-zones:
+ entitlements:
description: |
- Collection of availability zones
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
properties:
- availability-zone:
+ entitlement:
type: array
items:
- $ref: "#/definitions/availability-zone"
+ $ref: "#/definitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ 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: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
esr-system-info:
description: |
Persist common address information of external systems.
###### Related Nodes
- - FROM esr-ems (is composed of esr-system-info)
- - FROM esr-vnfm (is composed of esr-system-info)
- - FROM esr-thirdparty-sdnc (is composed of esr-system-info)
- - FROM cloud-region (is composed of esr-system-info)
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
required:
- esr-system-info-id
- user-name
type: array
items:
$ref: "#/definitions/esr-system-info"
- cloud-region:
+ esr-thirdparty-sdnc:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation.
+ Persist SDNC address information used by ONAP SDNC.
###### Related Nodes
- - TO esr-system-info (comprises cloud-region, One2Many)
- - TO complex (Many2One)
- - TO l3-network (Many2Many)
- - TO tenant (comprises cloud-region, One2Many)
- - TO image (comprises cloud-region, One2Many)
- - TO flavor (comprises cloud-region, One2Many)
- - TO availability-zone (comprises cloud-region, One2Many)
- - TO oam-network (comprises cloud-region, One2Many)
- - TO dvs-switch (comprises cloud-region, One2Many)
- - TO volume-group (comprises cloud-region, One2Many)
- - TO group-assignment (comprises cloud-region, One2Many)
- - TO snapshot (comprises cloud-region, One2Many)
- - TO zone (Many2One)
- - FROM pserver
- - FROM logical-link
+ - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
- - cloud-owner
- - cloud-region-id
- - sriov-automation
+ - thirdparty-sdnc-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. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
- identity-url:
- type: string
- description: URL of the keystone identity service
- cloud-zone:
- type: string
- description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
- complex-name:
+ thirdparty-sdnc-id:
type: string
- description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
- sriov-automation:
- type: boolean
- cloud-extra-info:
+ description: Unique ID of SDNC.
+ location:
type: string
- description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
- cloud-epa-caps:
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
type: string
- description: MultiVIM will discover and expose EPA capabilities.
+ 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.
- 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"
esr-system-info-list:
- type: array
- items:
- $ref: "#/definitions/esr-system-info"
- cloud-regions:
+ type: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-thirdparty-sdnc-list:
properties:
- cloud-region:
+ esr-thirdparty-sdnc:
type: array
items:
- $ref: "#/definitions/cloud-region"
- network-profile:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ esr-vnfm:
description: |
- Network profile populated by SDN-GP for SNMP
+ Persist VNFM address information used by VF-C.
###### Related Nodes
- - FROM generic-vnf
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
- - nm-profile-name
+ - vnfm-id
properties:
- nm-profile-name:
+ vnfm-id:
type: string
- description: Unique name of network profile.
- community-string:
+ description: Unique ID of VNFM.
+ vim-id:
type: string
- description: Encrypted SNMP community 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: "#/definitions/esr-system-info-list"
relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- network-profiles:
- description: |
- Collection of network profiles
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-vnfm-list:
properties:
- network-profile:
+ esr-vnfm:
type: array
items:
- $ref: "#/definitions/network-profile"
- sriov-pf:
+ $ref: "#/definitions/esr-vnfm"
+ evc:
description: |
- SR-IOV Physical Function
+ evc object is an optional child object of the Configuration object.
###### Related Nodes
- - FROM p-interface (is composed of sriov-pf)
- - FROM sriov-vf
+ - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
required:
- - pf-pci-id
+ - evc-id
properties:
- pf-pci-id:
+ evc-id:
type: string
- description: Identifier for the sriov-pf
- resource-version:
+ description: Unique/key field for the evc object
+ forwarding-path-topology:
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-pfs:
- description: |
- Collection of SR-IOV Physical Functions.
- properties:
- sriov-pf:
- type: array
- items:
- $ref: "#/definitions/sriov-pf"
- p-interface:
- description: |
- Physical interface (e.g., nic)
- ###### Related Nodes
- - TO l-interface (comprises p-interface, Many2Many)
- - TO physical-link (Many2Many)
- - TO logical-link (Many2One)
- - TO sriov-pf (comprises p-interface, One2One)
- - FROM lag-interface
- - FROM pserver (is composed of p-interface)
- - FROM pnf (is composed of p-interface)
- - FROM vpls-pe (is composed of p-interface)
- required:
- - interface-name
- - in-maint
- properties:
- interface-name:
+ description: Point-to-Point, Multi-Point
+ cir-value:
type: string
- description: Name that identifies the physical interface
- speed-value:
+ description: Commited Information Rate
+ cir-units:
type: string
- description: Captures the numeric part of the speed
- speed-units:
+ description: CIR units
+ connection-diversity-group-id:
type: string
- description: Captures the units corresponding to the speed
- port-description:
+ description: Diversity Group ID
+ service-hours:
type: string
- description: Nature of the services and connectivity on this port.
- equipment-identifier:
+ description: formerly Performance Group
+ esp-evc-circuit-id:
type: string
- description: CLEI or other specification for p-interface hardware.
- interface-role:
+ description: EVC Circuit ID of ESP EVC
+ esp-evc-cir-value:
type: string
- description: Role specification for p-interface hardware.
- interface-type:
+ description: Committed Information Rate (For ESP)
+ esp-evc-cir-units:
type: string
- description: Indicates the physical properties of the interface.
- prov-status:
+ description: CIR units (For ESP)
+ esp-itu-code:
type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- mac-addresss:
+ description: Identifies ESP
+ collector-pop-clli:
type: string
- description: MAC Address of the p-interface.
- resource-version:
+ description: Collector POP CLLI (from the hostname of the access pnf)
+ inter-connect-type-ingress:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- in-maint:
- type: boolean
- inv-status:
+ description: Interconnect type on ingress side of EVC.
+ tagmode-access-ingress:
type: string
- description: inventory status
+ 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"
- sriov-pfs:
- type: array
- items:
- $ref: "#/definitions/sriov-pf"
- l-interfaces:
+ 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: "#/definitions/l-interface"
- p-interfaces:
+ items:
+ $ref: "#/definitions/evc"
+ external-system:
description: |
- Collection of physical interfaces.
+ Namespace for external system.
properties:
- p-interface:
+ 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
+ properties:
+ extra-property:
type: array
items:
- $ref: "#/definitions/p-interface"
- lag-interface:
+ $ref: "#/definitions/extra-property"
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ flavor:
description: |
- Link aggregate interface
+ Openstack flavor.
###### Related Nodes
- - TO logical-link (Many2Many)
- - TO lag-link (Many2Many)
- - TO p-interface (Many2Many)
- - TO l-interface (comprises lag-interface, Many2Many)
- - FROM generic-vnf (is composed of lag-interface)
- - FROM pserver (is composed of lag-interface)
- - FROM pnf (is composed of lag-interface)
- - FROM vpls-pe (is composed of lag-interface)
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked to VSERVER
required:
- - interface-name
- - in-maint
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
properties:
- interface-name:
- type: string
- description: Name that identifies the link aggregate interface
- interface-description:
+ flavor-id:
type: string
- description: Human friendly text regarding this interface.
- resource-version:
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
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:
+ 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: Captures the units corresponding to the speed
- interface-id:
+ 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: ID of interface
- interface-role:
+ 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: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
- prov-status:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/definitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- in-maint:
- type: boolean
+ description: ingress, intermediate, egress
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- l-interfaces:
+ 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ 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: "#/definitions/l-interface"
- lag-interfaces:
+ $ref: "#/definitions/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: "#/definitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder"
+ forwarding-path:
description: |
- Collection of link aggregate interfaces.
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
properties:
- lag-interface:
+ 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: "#/definitions/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: "#/definitions/forwarder"
+ forwarding-paths:
+ properties:
+ forwarding-path:
type: array
items:
- $ref: "#/definitions/lag-interface"
- pserver:
+ $ref: "#/definitions/forwarding-path"
+ generic-vnf:
description: |
- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ General purpose VNF
###### 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)
- - TO zone (Many2One)
- - FROM generic-vnf
- - FROM group-assignment
- - FROM vserver
- - FROM logical-link
+ - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
required:
- - hostname
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
- in-maint
+ - is-closed-loop-disabled
properties:
- hostname:
+ vnf-id:
type: string
- description: Value from executing hostname on the compute node.
- ptnii-equip-name:
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
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:
+ description: vnf instance id.
+ vnf-name:
type: string
- description: Equipment type. Source of truth should define valid values.
- equip-vendor:
+ description: Name of VNF.
+ vnf-name2:
type: string
- description: Equipment vendor. Source of truth should define valid values.
- equip-model:
+ description: Alternate name of VNF.
+ vnf-type:
type: string
- description: Equipment model. Source of truth should define valid values.
- fqdn:
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
type: string
- description: Fully-qualified domain name
- pserver-selflink:
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
type: string
- description: URL to endpoint where AAI can get more details
- ipv4-oam-address:
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
type: string
- description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
- serial-number:
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
type: string
- description: Serial number, may be queried
- ipaddress-v4-loopback-0:
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
type: string
- description: IPV4 Loopback 0 address
- ipaddress-v6-loopback-0:
+ description: OBSOLETE - do not use
+ equipment-role:
type: string
- description: IPV6 Loopback 0 address
- ipaddress-v4-aim:
+ description: Client should send valid enumerated value
+ orchestration-status:
type: string
- description: IPV4 AIM address
- ipaddress-v6-aim:
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
type: string
- description: IPV6 AIM address
- ipaddress-v6-oam:
+ vnf-discriptor-name:
type: string
- description: IPV6 OAM address
- inv-status:
+ description: vnf discriptor name
+ job-id:
type: string
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
- pserver-id:
+ description: job id corresponding to vnf
+ heat-stack-id:
type: string
- description: ID of Pserver
- internet-topology:
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
type: string
- description: internet topology of Pserver
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT 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, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
in-maint:
type: boolean
+ is-closed-loop-disabled:
+ type: boolean
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- pserver-name2:
+ summary-status:
type: string
- description: alternative pserver name
- purpose:
+ description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ entitlement-assignment-group-uuid:
type: string
- description: purpose of pserver
- prov-status:
+ description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
+ entitlement-resource-uuid:
type: string
- description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
- management-option:
+ description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
+ license-assignment-group-uuid:
type: string
- description: Indicates who owns and or manages the device.
- host-profile:
+ description: UUID of the license assignment group. OBSOLETE - See child relationships.
+ license-key-uuid:
type: string
- description: The host profile that defines the configuration of the pserver.
+ description: UUID of the actual license resource. OBSOLETE - See child relationships.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
+ nf-type:
+ type: string
+ description: Generic description of the type of NF
+ nf-function:
+ type: string
+ description: English description of Network function that the specific VNF deployment is providing
+ nf-role:
+ type: string
+ description: role in the network that this model will be providing
+ nf-naming-code:
+ type: string
+ description: string assigned to this model used for naming purposes
+ selflink:
+ type: string
+ description: Path to the controller object.
+ ipv4-oam-gateway-address:
+ type: string
+ description: Gateway address
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Prefix length for oam-address
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for S-TAG to get to VCE
+ nm-profile-name:
+ type: string
+ description: Network Management profile of this VNF
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
+ l-interfaces:
type: array
items:
- $ref: "#/definitions/p-interface"
+ $ref: "#/definitions/l-interface"
lag-interfaces:
type: array
items:
$ref: "#/definitions/lag-interface"
- pservers:
+ vf-modules:
+ type: array
+ items:
+ $ref: "#/definitions/vf-module"
+ licenses:
+ type: array
+ items:
+ $ref: "#/definitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/definitions/entitlement"
+ generic-vnfs:
description: |
- Collection of compute hosts.
+ Collection of VNFs
properties:
- pserver:
+ generic-vnf:
type: array
items:
- $ref: "#/definitions/pserver"
- virtual-data-center:
+ $ref: "#/definitions/generic-vnf"
+ group-assignment:
description: |
- Virtual organization of cloud infrastructure elements in a data center context
+ Openstack group-assignment used to store exclusivity groups (EG).
###### Related Nodes
- - TO generic-vnf (Many2Many)
- - TO logical-link (Many2Many)
- - FROM connector
+ - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
required:
- - vdc-id
- - vdc-name
+ - group-id
+ - group-type
+ - group-name
properties:
- vdc-id:
+ group-id:
type: string
- description: Unique ID of the vdc
- vdc-name:
+ description: Group id, expected to be unique across cloud-region.
+ group-type:
type: string
- description: Name of the virtual data center
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- virtual-data-centers:
+ group-assignments:
description: |
- Virtual organization of cloud infrastructure elements in a data center context
+ Collection of openstack group assignments
properties:
- virtual-data-center:
+ group-assignment:
type: array
items:
- $ref: "#/definitions/virtual-data-center"
- 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"
- esr-ems:
+ $ref: "#/definitions/group-assignment"
+ host-route:
description: |
- Persist EMS address information used by EMS driver.
###### Related Nodes
- - TO esr-system-info (comprises esr-ems, One2Many)
+ - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
required:
- - ems-id
+ - host-route-id
+ - route-prefix
+ - next-hop
properties:
- ems-id:
+ host-route-id:
type: string
- description: Unique ID of EMS.
+ 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.
- esr-system-info-list:
- type: array
- items:
- $ref: "#/definitions/esr-system-info"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- esr-ems-list:
+ host-routes:
properties:
- esr-ems:
+ host-route:
type: array
items:
- $ref: "#/definitions/esr-ems"
- esr-vnfm:
+ $ref: "#/definitions/host-route"
+ hpa-capabilities:
description: |
- Persist VNFM address information used by VF-C.
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/definitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
###### Related Nodes
- - TO esr-system-info (comprises esr-vnfm, One2One)
+ - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
+ - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
required:
- - vnfm-id
+ - hpa-capability-id
+ - hpa-feature
properties:
- vnfm-id:
+ hpa-capability-id:
type: string
- description: Unique ID of VNFM.
- vim-id:
+ description: UUID to uniquely identify a HPA capability
+ hpa-feature:
type: string
- description: indecate the VIM to deploy VNF.
- certificate-url:
+ description: Name of the HPACapability
+ hpa-version:
type: string
- description: certificate url of VNFM.
+ 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.
- esr-system-info-list:
- type: array
- items:
- $ref: "#/definitions/esr-system-info"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- esr-vnfm-list:
- properties:
- esr-vnfm:
+ hpa-feature-attributes:
type: array
items:
- $ref: "#/definitions/esr-vnfm"
- esr-thirdparty-sdnc:
+ $ref: "#/definitions/hpa-feature-attributes"
+ hpa-feature-attributes:
description: |
- Persist SDNC address information used by ONAP SDNC.
+ HPA Capability Feature attributes
###### Related Nodes
- - TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
- - TO pnf (One2Many)
+ - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
required:
- - thirdparty-sdnc-id
+ - hpa-attribute-key
properties:
- thirdparty-sdnc-id:
- type: string
- description: Unique ID of SDNC.
- location:
+ hpa-attribute-key:
type: string
- description: used for DC type to indicate the location of SDNC, such as Core or Edge.
- product-name:
+ description: name of the specific HPA attribute
+ hpa-attribute-value:
type: string
- description: password used to access SDNC server.
+ 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.
- esr-system-info-list:
- type: array
- items:
- $ref: "#/definitions/esr-system-info"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- esr-thirdparty-sdnc-list:
- properties:
- esr-thirdparty-sdnc:
- type: array
- items:
- $ref: "#/definitions/esr-thirdparty-sdnc"
- external-system:
- description: |
- Namespace for external system.
- properties:
- esr-ems-list:
- type: array
- items:
- $ref: "#/definitions/esr-ems"
- esr-vnfm-list:
- type: array
- items:
- $ref: "#/definitions/esr-vnfm"
- esr-thirdparty-sdnc-list:
- type: array
- items:
- $ref: "#/definitions/esr-thirdparty-sdnc"
- connector:
+ image:
description: |
- Collection of resource instances used to connect a variety of disparate inventory widgets
+ Openstack image.
###### Related Nodes
- - TO virtual-data-center (Many2Many)
- - TO metadatum (comprises connector, Many2Many)
- - FROM service-instance
+ - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
required:
- - resource-instance-id
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
properties:
- resource-instance-id:
+ image-id:
type: string
- description: Unique id of resource instance.
- resource-version:
+ description: Image id, expected to be unique across cloud region
+ image-name:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- model-invariant-id:
+ description: Image name
+ image-architecture:
type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
+ description: Operating system architecture.
+ image-os-distro:
type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
+ description: The common name of the operating system distribution in lowercase
+ image-os-version:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ description: The operating system version as specified by the distributor.
+ application:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: The application that the image instantiates.
+ application-vendor:
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"
+ 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: "#/definitions/relationship"
metadata:
type: array
items:
$ref: "#/definitions/metadatum"
- connectors:
+ images:
description: |
- Collection of resource instances used to connect a variety of disparate inventory widgets
+ Collectio of Openstack images.
properties:
- connector:
+ image:
type: array
items:
- $ref: "#/definitions/connector"
- tunnel-xconnect:
+ $ref: "#/definitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
description: |
- Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ 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: "#/definitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
###### Related Nodes
- - FROM allotted-resource (is composed of tunnel-xconnect)
+ - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
- id
- - bandwidth-up-wan1
- - bandwidth-down-wan1
- - bandwidth-up-wan2
- - bandwidth-down-wan2
+ - description
+ - type
properties:
- id:
+ instance-group-role:
type: string
- description: Allotted Resource id UUID assigned to this instance.
- bandwidth-up-wan1:
+ description: role of the instance group.
+ model-invariant-id:
type: string
- description: The WAN uplink bandwidth for WAN1
- bandwidth-down-wan1:
+ description: ASDC model id for this resource or service model.
+ model-version-id:
type: string
- description: The WAN downlink bandwidth for WAN1
- bandwidth-up-wan2:
+ description: ASDC model version uid for this resource model.
+ id:
type: string
- description: The WAN uplink bandwidth for WAN2
- bandwidth-down-wan2:
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
type: string
- description: The WAN downlink bandwidth for WAN2
+ 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
type: array
items:
$ref: "#/definitions/relationship"
- tunnel-xconnects:
+ instance-groups:
description: |
- This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ Collection of openstack route table references
properties:
- tunnel-xconnect:
+ instance-group:
type: array
items:
- $ref: "#/definitions/tunnel-xconnect"
- allotted-resource:
- description: |
- Represents a slice or partial piece of a resource that gets separately allotted
- ###### Related Nodes
- - TO generic-vnf (Many2Many)
- - TO l3-network (Many2Many)
- - TO instance-group (Many2Many)
- - TO network-policy (One2One)
- - TO vlan (Many2Many)
- - TO l-interface (One2Many)
- - TO tunnel-xconnect (comprises allotted-resource, One2One)
- - TO vpn-binding (Many2Many)
- - TO allotted-resource (One2One)
- - FROM service-instance (is composed of allotted-resource)
- - FROM service-instance
- - FROM allotted-resource
- required:
- - id
+ $ref: "#/definitions/instance-group"
+ inventory:
properties:
- id:
- type: string
- description: Allotted Resource id UUID assigned to this instance.
- description:
- type: string
- description: The descriptive information assigned to this allotted resource instance
- selflink:
- type: string
- description: Link back to more information in the controller
- model-invariant-id:
- type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
- type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
- type: string
- description: the ASDC model version for this resource or service model.
- resource-version:
+ search:
+ type: object
+ $ref: "#/definitions/search"
+ actions:
+ type: object
+ $ref: "#/definitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/definitions/cloud-infrastructure"
+ external-system:
+ type: object
+ $ref: "#/definitions/external-system"
+ 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"
+ nodes:
+ type: array
+ items:
+ $ref: "#/definitions/aai-internal"
+ inventory-item:
+ properties:
+ inventory-item-type:
type: string
- description: Concurrency value
- orchestration-status:
+ inventory-item-link:
type: string
- description: Orchestration status
- operational-status:
+ 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: Indicator for whether the resource is considered operational
- type:
+ property-value:
type: string
- description: Generic description of the type of allotted resource.
- role:
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
type: string
- description: role in the network that this resource will be providing.
- tunnel-xconnects:
- type: array
- items:
- $ref: "#/definitions/tunnel-xconnect"
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- allotted-resources:
+ extra-properties:
+ type: object
+ $ref: "#/definitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/definitions/inventory-response-items"
+ inventory-response-items:
description: |
- This object is used to store slices of services being offered
+ Container for inventory items in response list
properties:
- allotted-resource:
+ inventory-response-item:
type: array
items:
- $ref: "#/definitions/allotted-resource"
- service-instance:
+ $ref: "#/definitions/inventory-response-item"
+ ipsec-configuration:
description: |
- Instance of a service
+ 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 zone (Many2One)
- - TO cvlan-tag (Many2Many)
- - TO pnf (One2Many)
- - TO connector (Many2Many)
- - TO metadatum (comprises service-instance, Many2Many)
- - TO logical-link (Many2Many)
- - TO vlan (One2Many)
- - TO service-instance (One2Many)
- - TO ctag-assignment (One2Many)
- - TO instance-group (Many2Many)
- - TO allotted-resource (comprises service-instance, Many2Many)
- - TO allotted-resource (Many2Many)
- - FROM generic-vnf
- - FROM l3-network
- - FROM owning-entity
- - FROM project
- - FROM service-subscription (is composed of service-instance)
- - FROM vce
- - FROM service-instance
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
required:
- - service-instance-id
- - service-type
- - service-role
+ - ipsec-configuration-id
properties:
- service-instance-id:
+ ipsec-configuration-id:
type: string
- description: Uniquely identifies this instance of a service
- service-instance-name:
+ description: UUID of this configuration
+ requested-vig-address-type:
type: string
- description: This field will store a name assigned to the service-instance.
- service-type:
+ description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
+ requested-encryption-strength:
type: string
- description: String capturing type of service.
- service-role:
+ description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
+ requested-dmz-type:
type: string
- description: String capturing the service role.
- environment-context:
+ description: ATT can offer a shared DMZ or a DMZ specific to a customer
+ shared-dmz-network-address:
type: string
- description: This field will store the environment context assigned to the service-instance.
- workload-context:
+ description: Network address of shared DMZ
+ requested-customer-name:
type: string
- description: This field will store the workload context assigned to the service-instance.
- model-invariant-id:
+ description: If the DMZ is a custom DMZ, this field will indicate the customer information
+ ike-version:
type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
+ description: can be 1 or 2
+ ikev1-authentication:
type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
+ description: Contains values like md5, sha1, sha256, sha384
+ ikev1-encryption:
type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
+ description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
+ ikev1-dh-group:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
+ ikev1-am-group-id:
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:
+ description: Group name defined in VIG for clients using aggressive mode
+ ikev1-am-password:
type: string
- description: Indicates the total bandwidth to be used for this service.
- bandwidth-up-wan1:
+ description: pre-shared key for the above group name
+ ikev1-sa-lifetime:
type: string
- description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
- bandwidth-down-wan1:
+ description: Lifetime for IKEv1 SA
+ ipsec-authentication:
type: string
- description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
- bandwidth-up-wan2:
+ description: md5, sha1, sha256, sha384
+ ipsec-encryption:
type: string
- description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
- bandwidth-down-wan2:
+ description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
+ ipsec-sa-lifetime:
type: string
- description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
- vhn-portal-url:
+ description: Life time for IPSec SA
+ ipsec-pfs:
type: string
- description: URL customers will use to access the vHN Portal.
- service-instance-location-id:
+ description: enable PFS or not
+ xauth-userid:
type: string
- description: An identifier that customers assign to the location where this service is being used.
- resource-version:
+ description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
+ xauth-user-password:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- selflink:
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
type: string
- description: Path to the controller object.
- orchestration-status:
+ description: The time between DPD probe
+ dpd-frequency:
type: string
- description: Orchestration status of this service.
+ 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: "#/definitions/relationship"
- metadata:
- type: array
- items:
- $ref: "#/definitions/metadatum"
- allotted-resources:
+ vig-servers:
type: array
items:
- $ref: "#/definitions/allotted-resource"
- 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:
- description: |
- Object that group service instances.
- ###### Related Nodes
- - TO service-instance (comprises service-subscription, Many2Many)
- - FROM customer (is composed of service-subscription)
- - FROM tenant
- required:
- - service-type
+ $ref: "#/definitions/ipsec-configuration"
+ key-data:
properties:
- service-type:
- type: string
- description: Value defined by orchestration to identify this service across ECOMP.
- temp-ub-sub-account-id:
+ key-name:
type: string
- description: This property will be deleted from A&AI in the near future. Only stop gap solution.
- resource-version:
+ key-value:
type: string
- 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"
- customer:
+ l-interface:
description: |
- customer identifiers to provide linkage back to BSS information.
+ Logical interfaces, e.g., a vnic.
###### Related Nodes
- - TO service-subscription (comprises customer, Many2Many)
+ - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
required:
- - global-customer-id
- - subscriber-name
- - subscriber-type
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
properties:
- global-customer-id:
+ interface-name:
type: string
- description: Global customer id used across ECOMP to uniquely identify customer.
- subscriber-name:
+ description: Name given to the interface
+ interface-role:
type: string
- description: Subscriber name, an alternate way to retrieve a customer.
- subscriber-type:
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
type: string
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- service-subscriptions:
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
+ vlans:
type: array
items:
- $ref: "#/definitions/service-subscription"
+ $ref: "#/definitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-vf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- customers:
+ 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 customer identifiers to provide linkage back to BSS information.
+ Collection of logical interfaces.
properties:
- customer:
+ l-interface:
type: array
items:
- $ref: "#/definitions/customer"
- line-of-business:
+ $ref: "#/definitions/l-interface"
+ l3-interface-ipv4-address-list:
description: |
- describes a line-of-business
+ IPv4 Address Range
###### Related Nodes
- - TO generic-vnf (Many2Many)
+ - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
required:
- - line-of-business-name
+ - l3-interface-ipv4-address
properties:
- line-of-business-name:
+ l3-interface-ipv4-address:
type: string
- description: Name of the line-of-business (product)
+ 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: "#/definitions/relationship"
- lines-of-business:
- description: |
- Collection of lines-of-business
- properties:
- line-of-business:
- type: array
- items:
- $ref: "#/definitions/line-of-business"
- owning-entity:
+ l3-interface-ipv6-address-list:
description: |
- describes an owning-entity
+ IPv6 Address Range
###### Related Nodes
- - TO service-instance (One2Many)
+ - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
required:
- - owning-entity-id
- - owning-entity-name
+ - l3-interface-ipv6-address
properties:
- owning-entity-id:
- type: string
- description: UUID of an owning entity
- owning-entity-name:
+ l3-interface-ipv6-address:
type: string
- description: Owning entity name
+ 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/relationship"
- owning-entities:
- description: |
- Collection of owning-entities
- properties:
- owning-entity:
- type: array
- items:
- $ref: "#/definitions/owning-entity"
- platform:
+ l3-network:
description: |
- describes a platform
+ Generic network definition
###### Related Nodes
- - TO generic-vnf (Many2Many)
+ - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
required:
- - platform-name
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
properties:
- platform-name:
+ network-id:
type: string
- description: Name of the platform
- resource-version:
+ 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
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ 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
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ physical-network-name:
+ type: string
+ description: Name associated with the physical network.
+ is-provider-network:
+ type: boolean
+ is-shared-network:
+ type: boolean
+ is-external-network:
+ type: boolean
+ selflink:
+ type: string
+ description: Path to the controller object.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ 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"
- platforms:
- description: |
- Collection of platforms
+ description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
+ l3-networks:
properties:
- platform:
+ l3-network:
type: array
items:
- $ref: "#/definitions/platform"
- project:
+ $ref: "#/definitions/l3-network"
+ lag-interface:
description: |
- describes the project
+ Link aggregate interface
###### Related Nodes
- - TO service-instance (One2Many)
+ - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
required:
- - project-name
+ - interface-name
+ - in-maint
properties:
- project-name:
+ interface-name:
type: string
- description: Name of the project deploying a service
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ interface-id:
+ type: string
+ description: ID of interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ in-maint:
+ type: boolean
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- projects:
- description: |
- Collection of projects
- properties:
- project:
+ l-interfaces:
type: array
- items:
- $ref: "#/definitions/project"
- business:
+ items:
+ $ref: "#/definitions/l-interface"
+ lag-interfaces:
description: |
- Namespace for business related constructs
+ Collection of link aggregate interfaces.
properties:
- connectors:
- type: array
- items:
- $ref: "#/definitions/connector"
- customers:
- type: array
- items:
- $ref: "#/definitions/customer"
- lines-of-business:
- type: array
- items:
- $ref: "#/definitions/line-of-business"
- owning-entities:
- type: array
- items:
- $ref: "#/definitions/owning-entity"
- platforms:
- type: array
- items:
- $ref: "#/definitions/platform"
- projects:
+ lag-interface:
type: array
- items:
- $ref: "#/definitions/project"
- vnf-image:
+ items:
+ $ref: "#/definitions/lag-interface"
+ lag-link:
description: |
- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ LAG links can connect lag-interfaces
###### Related Nodes
- - FROM generic-vnf
+ - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
required:
- - vnf-image-uuid
- - application
- - application-vendor
+ - link-name
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:
+ link-name:
type: string
- description: URL to endpoint where AAI can get more details
+ 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"
- vnf-images:
+ lag-links:
description: |
- Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ Collection of link aggregation connections
properties:
- vnf-image:
+ lag-link:
type: array
items:
- $ref: "#/definitions/vnf-image"
- service:
+ $ref: "#/definitions/lag-link"
+ license:
description: |
- Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
required:
- - service-id
- - service-description
+ - group-uuid
+ - resource-uuid
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:
+ group-uuid:
type: string
- description: Description of the service
- service-selflink:
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ resource-uuid:
type: string
- description: URL to endpoint where AAI can get more details
+ description: Unique ID of a license resource.
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
+ description: Concurrency value
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- services:
+ licenses:
description: |
- Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
properties:
- service:
+ license:
type: array
items:
- $ref: "#/definitions/service"
- service-capability:
+ $ref: "#/definitions/license"
+ line-of-business:
description: |
- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ describes a line-of-business
###### Related Nodes
- - FROM availability-zone
- - FROM oam-network
+ - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
required:
- - service-type
- - vnf-type
+ - line-of-business-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:
+ line-of-business-name:
type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- service-capabilities:
+ lines-of-business:
description: |
- Collection of service capabilities.
+ Collection of lines-of-business
properties:
- service-capability:
+ line-of-business:
type: array
items:
- $ref: "#/definitions/service-capability"
- element-choice-set:
+ $ref: "#/definitions/line-of-business"
+ logical-link:
description: |
- This is how we would capture constraints defining allowed sets of elements.
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
###### Related Nodes
- - TO model-element (comprises element-choice-set, One2Many)
- - FROM constrained-element-set (is composed of element-choice-set)
+ - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
required:
- - element-choice-set-uuid
- - element-choice-set-name
+ - link-name
+ - in-maint
+ - link-type
properties:
- element-choice-set-uuid:
+ link-name:
type: string
- element-choice-set-name:
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ link-type:
type: string
- cardinality:
+ 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
- model-elements:
- type: array
- items:
- $ref: "#/definitions/model-element"
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ operational-status:
+ type: string
+ description: Indication of operational status of the logical link.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ link-role:
+ type: string
+ description: Indication of the network use of the logical link.
+ link-name2:
+ type: string
+ description: Alias or alternate name (CLCI or D1 name).
+ link-id:
+ type: string
+ description: UUID of the logical-link, SDNC generates this.
+ circuit-id:
+ type: string
+ description: Circuit id
+ purpose:
+ type: string
+ description: Reason for this entity, role it is playing
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- element-choice-sets:
+ logical-links:
+ description: |
+ Collection of logical connections
properties:
- element-choice-set:
+ logical-link:
type: array
items:
- $ref: "#/definitions/element-choice-set"
- constrained-element-set:
+ $ref: "#/definitions/logical-link"
+ metadata:
description: |
- This is how we would capture constraints defining allowed sets of elements.
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
###### 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 configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
required:
- - constrained-element-set-uuid
- - constraint-type
- - check-type
+ - metaname
+ - metaval
properties:
- constrained-element-set-uuid:
+ metaname:
type: string
- constraint-type:
+ metaval:
type: string
- check-type:
+ 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, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
resource-version:
type: string
- element-choice-sets:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
type: array
items:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/model-ver"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- constrained-element-sets:
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
properties:
- constrained-element-set:
- type: array
- items:
- $ref: "#/definitions/constrained-element-set"
+ query-parameters:
+ type: object
+ $ref: "#/definitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/definitions/instance-filters"
+ secondary-filts:
+ type: object
+ $ref: "#/definitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ 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 org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
required:
- model-constraint-uuid
- constrained-element-set-uuid-to-replace
description: |
Defines how other models combine to make up a higher-level model.
###### Related Nodes
- - TO model-ver (Many2One)
- - TO model-element (comprises model-element, One2Many)
- - TO model-constraint (comprises model-element, One2Many)
- - TO constrained-element-set (comprises model-element, One2Many)
- - FROM model-ver (is composed of model-element)
- - FROM element-choice-set (is composed of model-element)
- - FROM model-element (is composed of model-element)
+ - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
required:
- model-element-uuid
- new-data-del-flag
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-element (comprises model-ver, One2Many)
- - TO metadatum (comprises model-ver, One2Many)
- - FROM model (is composed of model-ver)
- - FROM model-element
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
required:
- model-version-id
- model-name
type: array
items:
$ref: "#/definitions/model-ver"
- model:
- description: |
- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
- ###### Related Nodes
- - TO model-ver (comprises model, One2Many)
- - FROM named-query
- - FROM named-query-element
- - FROM instance-group
- required:
- - model-invariant-id
- - model-type
- properties:
- model-invariant-id:
- type: string
- description: Unique identifier corresponding to the main definition of a model in ASDC
- model-type:
- type: string
- description: Type of the model, e.g., service, resource, widget, etc.
- resource-version:
- type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- model-vers:
- type: array
- items:
- $ref: "#/definitions/model-ver"
- relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
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
###### 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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
required:
- named-query-element-uuid
properties:
type: array
items:
$ref: "#/definitions/named-query-element"
- named-query:
+ network:
description: |
- TBD
- ###### 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"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/definitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/definitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/definitions/configurations"
+ 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
###### Related Nodes
- - TO lag-link (Many2Many)
- - TO pnf (Many2Many)
- - TO logical-link (One2Many)
- - TO generic-vnf (Many2Many)
- - TO pserver (Many2Many)
- - TO cloud-region (Many2Many)
- - TO vpn-binding (Many2Many)
- - FROM l-interface
- - FROM lag-interface
- - FROM p-interface
- - FROM service-instance
- - FROM virtual-data-center
- - FROM vlan
- - FROM logical-link
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
required:
- - link-name
- - in-maint
- - link-type
+ - network-policy-id
properties:
- link-name:
- type: string
- description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
- in-maint:
- type: boolean
- 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.
- model-invariant-id:
- type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
- type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
- type: string
- description: the ASDC model version for this resource or service model.
- widget-model-id:
- type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
- type: string
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- operational-status:
- type: string
- description: Indication of operational status of the logical link.
- prov-status:
- type: string
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- link-role:
- type: string
- description: Indication of the network use of the logical link.
- link-name2:
- type: string
- description: Alias or alternate name (CLCI or D1 name).
- link-id:
- type: string
- description: UUID of the logical-link, SDNC generates this.
- circuit-id:
- type: string
- description: Circuit id
- purpose:
- type: string
- description: Reason for this entity, role it is playing
relationship-list:
type: array
items:
$ref: "#/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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
type: string
- description: 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-status:
type: string
- description: The type of destinatination equipment. Could be Router, UCPE, etc.
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- 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:
+ $ref: "#/definitions/newvce"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/definitions/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: "#/definitions/key-data"
+ selflink:
+ type: string
+ oam-network:
description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
###### Related Nodes
- - TO site-pair (comprises routing-instance, Many2Many)
- - FROM site-pair-set (is composed of routing-instance)
+ - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
required:
- - routing-instance-id
+ - network-uuid
+ - network-name
+ - cvlan-tag
properties:
- routing-instance-id:
+ network-uuid:
type: string
- description: Unique id of routing instance
- rpm-owner:
+ description: UUID of the network. Unique across a cloud-region
+ network-name:
type: string
- description: rpm owner
+ 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 org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.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"
- route-target:
+ $ref: "#/definitions/operational-environment"
+ overloaded-model:
description: |
- Route target information
- ###### Related Nodes
- - FROM vpn-binding (is composed of route-target)
+ Allows for legacy POST of old-style and new-style models
required:
- - global-route-target
- - route-target-role
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
properties:
- global-route-target:
+ model-invariant-id:
type: string
- description: Number used to identify an RT, globally unique in the network
- route-target-role:
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-name-version-id:
type: string
- description: Role assigned to this route target
+ 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: "#/definitions/model-vers"
relationship-list:
- type: array
- items:
- $ref: "#/definitions/relationship"
- route-targets:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ owning-entities:
description: |
- Collection of route target information
+ Collection of owning-entities
properties:
- route-target:
+ owning-entity:
type: array
items:
- $ref: "#/definitions/route-target"
- vpn-binding:
+ $ref: "#/definitions/owning-entity"
+ owning-entity:
description: |
- VPN binding
+ describes an owning-entity
###### Related Nodes
- - TO route-target (comprises vpn-binding, One2Many)
- - FROM l3-network
- - FROM logical-link
- - FROM allotted-resource
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
required:
- - vpn-id
- - vpn-name
+ - owning-entity-id
+ - owning-entity-name
properties:
- vpn-id:
- type: string
- description: VPN ID, globally unique within A&AI
- vpn-name:
- type: string
- description: VPN Name
- vpn-platform:
- type: string
- description: the platform associated with the VPN example AVPN, Mobility
- vpn-type:
- type: string
- description: Type of the vpn, should be taken from enumerated/valid values
- vpn-region:
- type: string
- description: region of customer vpn
- customer-vpn-id:
+ owning-entity-id:
type: string
- description: id for this customer vpn
- route-distinguisher:
+ description: UUID of an owning entity
+ owning-entity-name:
type: string
- description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ description: Owning entity name
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- route-targets:
- type: array
- items:
- $ref: "#/definitions/route-target"
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"
- vpls-pe:
+ p-interface:
description: |
- VPLS Provider Edge routers.
+ Physical interface (e.g., nic)
###### Related Nodes
- - TO complex (Many2Many)
- - TO ctag-pool (Many2Many)
- - TO p-interface (comprises vpls-pe, Many2Many)
- - TO lag-interface (comprises vpls-pe, Many2Many)
+ - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
required:
- - equipment-name
+ - interface-name
+ - in-maint
properties:
- equipment-name:
+ interface-name:
type: string
- prov-status:
+ description: Name that identifies the physical interface
+ speed-value:
type: string
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- ipv4-oam-address:
+ description: Captures the numeric part of the speed
+ speed-units:
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: Captures the units corresponding to the speed
+ port-description:
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: Nature of the services and connectivity on this port.
+ equipment-identifier:
+ type: string
+ description: CLEI or other specification for p-interface hardware.
+ interface-role:
+ type: string
+ description: Role specification for p-interface hardware.
+ interface-type:
+ type: string
+ description: Indicates the physical properties of the interface.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ inv-status:
+ type: string
+ description: inventory status
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
+ sriov-pfs:
type: array
items:
- $ref: "#/definitions/p-interface"
- lag-interfaces:
+ $ref: "#/definitions/sriov-pf"
+ l-interfaces:
type: array
items:
- $ref: "#/definitions/lag-interface"
- vpls-pes:
+ $ref: "#/definitions/l-interface"
+ p-interfaces:
description: |
- Collection of VPLS Provider Edge routers
+ Collection of physical interfaces.
properties:
- vpls-pe:
+ p-interface:
type: array
items:
- $ref: "#/definitions/vpls-pe"
- multicast-configuration:
+ $ref: "#/definitions/p-interface"
+ physical-link:
description: |
+ Collection of physical connections, typically between p-interfaces
###### Related Nodes
- - FROM vlan
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
required:
- - multicast-configuration-id
- - multicast-protocol
- - rp-type
+ - link-name
properties:
- multicast-configuration-id:
+ link-name:
type: string
- description: Unique id of multicast configuration.
- multicast-protocol:
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ speed-value:
type: string
- description: protocol of multicast configuration
- rp-type:
+ description: Captures the numeric part of the speed
+ speed-units:
type: string
- description: rp type of multicast configuration
+ description: Captures the units corresponding to the speed
+ circuit-id:
+ type: string
+ description: Circuit it
+ dual-mode:
+ type: string
+ description: Dual access mode (e.g., primary, secondary
+ management-option:
+ type: string
+ description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
+ service-provider-name:
+ type: string
+ description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- multicast-configurations:
+ physical-links:
description: |
- multicast configuration of generic-vnf ip-address
+ Collection of physical connections, typically between p-interfaces
properties:
- multicast-configuration:
+ physical-link:
type: array
items:
- $ref: "#/definitions/multicast-configuration"
- cvlan-tag-entry:
+ $ref: "#/definitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
required:
- - cvlan-tag
+ - platform-name
properties:
- cvlan-tag:
- type: integer
- format: int64
- description: See mis-na-virtualization-platform.yang
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- cvlan-tags:
+ platforms:
+ description: |
+ Collection of platforms
properties:
- cvlan-tag-entry:
+ platform:
type: array
items:
- $ref: "#/definitions/cvlan-tag-entry"
+ $ref: "#/definitions/platform"
+ pnf:
+ description: |
+ PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ 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 ATT 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.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ nf-role:
+ type: string
+ description: Nf Role is the role performed by this instance in the network.
+ 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"
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $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 org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
required:
- interface-id
- orchestration-status
type: array
items:
$ref: "#/definitions/port-group"
- license:
+ project:
description: |
- Metadata for license group.
+ describes the project
###### Related Nodes
- - FROM generic-vnf (is composed of license)
- - FROM vce (is composed of license)
+ - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
required:
- - group-uuid
- - resource-uuid
+ - project-name
properties:
- group-uuid:
- type: string
- description: Unique ID for the license group the resource belongs to, should be uuid.
- resource-uuid:
+ project-name:
type: string
- description: Unique ID of a license resource.
+ description: Name of the project deploying a service
resource-version:
type: string
- description: Concurrency value
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- licenses:
+ projects:
description: |
- Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ Collection of projects
properties:
- license:
+ project:
type: array
items:
- $ref: "#/definitions/license"
- entitlement:
+ $ref: "#/definitions/project"
+ properties:
description: |
- Metadata for entitlement group.
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
###### Related Nodes
- - FROM generic-vnf (is composed of entitlement)
- - FROM vce (is composed of entitlement)
+ - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
required:
- - group-uuid
- - resource-uuid
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
properties:
- group-uuid:
+ property-constraint-uuid:
type: string
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
- resource-uuid:
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
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
+ property-constraints:
properties:
- entitlement:
+ property-constraint:
type: array
items:
- $ref: "#/definitions/entitlement"
- vce:
+ $ref: "#/definitions/property-constraint"
+ pserver:
description: |
- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
###### Related Nodes
- - TO availability-zone (Many2Many)
- - TO complex (Many2Many)
- - TO port-group (comprises vce, Many2Many)
- - TO vserver (Many2Many)
- - TO service-instance (Many2Many)
- - TO entitlement (comprises vce, One2Many)
- - TO license (comprises vce, One2Many)
+ - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
required:
- - vnf-id
- - vnf-name
- - vnf-type
+ - hostname
+ - in-maint
properties:
- vnf-id:
+ hostname:
type: string
- description: Unique id of VNF. This is unique across the graph.
- vnf-name:
+ description: Value from executing hostname on the compute node.
+ ptnii-equip-name:
type: string
- description: Name of VNF.
- vnf-name2:
+ 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: Alternate name of VNF.
- vnf-type:
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- service-id:
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
type: string
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- regional-resource-zone:
+ description: Equipment model. Source of truth should define valid values.
+ fqdn:
type: string
- description: Regional way of organizing pservers, source of truth should define values
- prov-status:
+ description: Fully-qualified domain name
+ pserver-selflink:
type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- operational-status:
+ description: URL to endpoint where AAI can get more details
+ ipv4-oam-address:
type: string
- description: Indicator for whether the resource is considered operational
- license-key:
+ description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
+ serial-number:
type: string
- description: OBSOLETE - do not use
- equipment-role:
+ description: Serial number, may be queried
+ ipaddress-v4-loopback-0:
type: string
- description: Network role being played by this VNF
- orchestration-status:
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
type: string
- description: Orchestration status of this VNF, mastered by MSO
- heat-stack-id:
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- vpe-id:
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
type: string
- description: Unique ID of VPE connected to this VCE.
- v6-vce-wan-address:
+ description: IPV6 OAM address
+ inv-status:
type: string
- description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
- ipv4-oam-address:
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
type: string
- description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- ipv4-loopback0-address:
+ pserver-name2:
type: string
- description: Loopback0 address
- entitlement-resource-uuid:
+ description: alternative pserver name
+ purpose:
type: string
- description: OBSOLETE - see child relationships
- port-groups:
- type: array
- items:
- $ref: "#/definitions/port-group"
- licenses:
+ description: purpose of pserver
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ management-option:
+ type: string
+ description: Indicates who owns and or manages the device.
+ host-profile:
+ type: string
+ description: The host profile that defines the configuration of the pserver.
+ relationship-list:
type: array
items:
- $ref: "#/definitions/license"
- entitlements:
+ $ref: "#/definitions/relationship"
+ p-interfaces:
type: array
items:
- $ref: "#/definitions/entitlement"
- relationship-list:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
type: array
items:
- $ref: "#/definitions/relationship"
- vces:
+ $ref: "#/definitions/lag-interface"
+ pservers:
description: |
- Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ Collection of compute hosts.
properties:
- vce:
+ pserver:
type: array
items:
- $ref: "#/definitions/vce"
- vnfc:
+ $ref: "#/definitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/definitions/named-query"
+ overloaded-model:
+ type: object
+ $ref: "#/definitions/overloaded-model"
+ related-lookup:
description: |
+ TBD
###### Related Nodes
- - TO instance-group (Many2Many)
- - TO vip-ipv4-address-list (Many2Many)
- - TO vip-ipv6-address-list (Many2Many)
- - FROM vserver
- - FROM vf-module
- - FROM generic-vnf
- - FROM l3-interface-ipv4-address-list (comprises vnfc)
- - FROM l3-interface-ipv6-address-list (comprises vnfc)
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
required:
- - vnfc-name
- - nfc-naming-code
- - nfc-function
- - in-maint
- - is-closed-loop-disabled
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
properties:
- vnfc-name:
- type: string
- description: Unique ID of vnfc.
- nfc-naming-code:
- type: string
- description: Short code that is used in naming instances of the item being modeled
- nfc-function:
- type: string
- description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
- prov-status:
+ related-lookup-uuid:
type: string
- description: prov status of this vnfc
- orchestration-status:
+ source-node-type:
type: string
- description: Orchestration status of this VNF, mastered by APP-C
- ipaddress-v4-oam-vip:
+ source-node-property:
type: string
- description: Oam V4 vip address of this vnfc
- in-maint:
- type: boolean
- is-closed-loop-disabled:
- type: boolean
- group-notation:
+ target-node-type:
type: string
- description: Group notation of VNFC
- model-invariant-id:
+ target-node-property:
type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
+ property-collect-list:
type: string
- description: the ASDC model version for this resource or service model.
resource-version:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- 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"
- vnfcs:
- description: |
- virtual network components associated with a vserver from application controller.
+ related-lookups:
properties:
- vnfc:
+ related-lookup:
type: array
items:
- $ref: "#/definitions/vnfc"
- host-route:
- description: |
- ###### Related Nodes
- - FROM subnet (is composed of host-route)
- required:
- - host-route-id
- - route-prefix
- - next-hop
+ $ref: "#/definitions/related-lookup"
+ related-to-property:
properties:
- host-route-id:
- type: string
- description: host-route id
- route-prefix:
+ property-key:
type: string
- description: subnet prefix
- next-hop:
+ description: Key part of a key/value pair
+ property-value:
type: string
- description: Could be ip-address, hostname, or service-instance
- next-hop-type:
+ description: Value part of a key/value pair
+ relationship:
+ properties:
+ related-to:
type: string
- description: Should be ip-address, hostname, or service-instance to match next-hop
- resource-version:
+ description: A keyword provided by A&AI to indicate type of node.
+ related-link:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- relationship-list:
+ description: URL to the object in A&AI.
+ relationship-data:
type: array
- items:
- $ref: "#/definitions/relationship"
- host-routes:
+ items:
+ $ref: "#/definitions/relationship-data"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
properties:
- host-route:
+ 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/host-route"
- subnet:
+ $ref: "#/definitions/relationship"
+ reserved-prop-names:
description: |
- ###### Related Nodes
- - TO host-route (comprises subnet, One2Many)
- - FROM l3-interface-ipv4-address-list
- - FROM l3-interface-ipv6-address-list
- - FROM l3-network (is composed of subnet)
- required:
- - subnet-id
- - dhcp-enabled
+ Internal map to define some reserved properties of a vertex
properties:
- subnet-id:
- type: string
- description: Subnet ID, should be UUID.
- subnet-name:
+ last-mod-source-of-truth:
type: string
- description: Name associated with the subnet.
- neutron-subnet-id:
+ aai-node-type:
type: string
- description: Neutron id of this subnet
- gateway-address:
+ aai-created-ts:
+ type: integer
+ format: int64
+ aai-unique-key:
type: string
- description: gateway ip address
- network-start-address:
+ aai-last-mod-ts:
+ type: integer
+ format: int64
+ source-of-truth:
type: string
- description: network start address
- cidr-mask:
+ aai-uri:
type: string
- description: cidr mask
- ip-version:
+ 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: ip version
- orchestration-status:
+ description: The specific type of node in the A&AI graph
+ resource-link:
type: string
- description: Orchestration status of this VNF, mastered by MSO
- dhcp-enabled:
- type: boolean
- dhcp-start:
+ description: The URL to the specific resource
+ route-table-reference:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ properties:
+ route-table-reference-id:
type: string
- description: the start address reserved for use by dhcp
- dhcp-end:
+ description: Route Table Reference id, UUID assigned to this instance.
+ route-table-reference-fqdn:
type: string
- description: the last address reserved for use by dhcp
- subnet-role:
+ description: FQDN entry in the route table.
+ resource-version:
type: string
- description: role of the subnet, referenced when assigning IPs
- ip-assignment-direction:
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/definitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ required:
+ - global-route-target
+ - route-target-role
+ properties:
+ global-route-target:
type: string
- description: ip address assignment direction of the subnet
+ 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.
- subnet-sequence:
- type: integer
- format: int32
- description: sequence of the subnet
- host-routes:
- type: array
- items:
- $ref: "#/definitions/host-route"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- subnets:
+ route-targets:
+ description: |
+ Collection of route target information
properties:
- subnet:
+ route-target:
type: array
items:
- $ref: "#/definitions/subnet"
- ctag-assignment:
+ $ref: "#/definitions/route-target"
+ routing-instance:
description: |
###### Related Nodes
- - FROM l3-network (is composed of ctag-assignment)
- - FROM service-instance
+ - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
required:
- - vlan-id-inner
+ - routing-instance-id
properties:
- vlan-id-inner:
- type: integer
- format: int64
- description: id.
+ 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: "#/definitions/site-pair"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- ctag-assignments:
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
properties:
- ctag-assignment:
+ routing-instance:
type: array
items:
- $ref: "#/definitions/ctag-assignment"
+ $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
+ 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: "#/definitions/secondary-filt"
segmentation-assignment:
description: |
Openstack segmentation assignment.
###### Related Nodes
- - FROM l3-network (is composed of segmentation-assignment)
+ - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
required:
- segmentation-id
properties:
type: array
items:
$ref: "#/definitions/segmentation-assignment"
- l3-network:
+ service:
description: |
- Generic network definition
- ###### Related Nodes
- - TO vpn-binding (Many2Many)
- - TO instance-group (Many2Many)
- - TO subnet (comprises l3-network, Many2Many)
- - TO service-instance (Many2Many)
- - TO ctag-assignment (comprises l3-network, Many2Many)
- - TO network-policy (Many2Many)
- - TO segmentation-assignment (comprises l3-network, One2Many)
- - TO route-table-reference (Many2Many)
- - FROM cloud-region
- - FROM complex
- - FROM generic-vnf
- - FROM l3-interface-ipv4-address-list
- - FROM l3-interface-ipv6-address-list
- - FROM tenant
- - FROM vf-module
- - FROM allotted-resource
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
required:
- - network-id
- - network-name
- - is-bound-to-vpn
- - is-provider-network
- - is-shared-network
- - is-external-network
+ - service-id
+ - service-description
properties:
- network-id:
+ service-id:
type: string
- description: Network ID, should be uuid. Unique across A&AI.
- network-name:
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ service-description:
type: string
- description: Name of the network, governed by some naming convention..
- network-type:
+ description: Description of the service
+ service-selflink:
type: string
- description: Type of the network - who defines these values?
- network-role:
+ description: URL to endpoint where AAI can get more details
+ resource-version:
type: string
- description: Role the network plans - who defines these values?
- network-technology:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-version:
type: string
- description: Network technology - who defines these values?
- neutron-network-id:
+ description: service version
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $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 availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
+ required:
+ - service-type
+ - vnf-type
+ properties:
+ service-type:
type: string
- description: Neutron network id of this Interface
- is-bound-to-vpn:
- type: boolean
- service-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: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- network-role-instance:
- type: integer
- format: int64
- description: network role instance
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- orchestration-status:
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ 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: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
type: string
- description: Orchestration status of this VNF, mastered by MSO
- heat-stack-id:
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
+ description: This field will store a name assigned to the service-instance.
+ service-type:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- contrail-network-fqdn:
+ description: String capturing type of service.
+ service-role:
type: string
- description: Contrail FQDN for the network
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
model-invariant-id:
type: string
description: the ASDC model id for this resource or service model.
persona-model-version:
type: string
description: the ASDC model version for this resource or service model.
- model-customization-id:
- type: string
- description: captures the id of all the configuration used to customize the resource for the service.
widget-model-id:
type: string
description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version:
type: string
description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- physical-network-name:
+ bandwidth-total:
type: string
- description: Name associated with the physical network.
- is-provider-network:
- type: boolean
- is-shared-network:
- type: boolean
- is-external-network:
- type: boolean
+ 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.
selflink:
type: string
description: Path to the controller object.
- operational-status:
+ orchestration-status:
type: string
- description: Indicator for whether the resource is considered operational.
- subnets:
- type: array
- items:
- $ref: "#/definitions/subnet"
- ctag-assignments:
+ description: Orchestration status of this service.
+ relationship-list:
type: array
items:
- $ref: "#/definitions/ctag-assignment"
- segmentation-assignments:
+ $ref: "#/definitions/relationship"
+ metadata:
type: array
items:
- $ref: "#/definitions/segmentation-assignment"
- relationship-list:
+ $ref: "#/definitions/metadatum"
+ allotted-resources:
type: array
items:
- $ref: "#/definitions/relationship"
- description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
- l3-networks:
+ $ref: "#/definitions/allotted-resource"
+ service-instances:
+ description: |
+ Collection of service instances
properties:
- l3-network:
+ service-instance:
type: array
items:
- $ref: "#/definitions/l3-network"
- network-policy:
+ $ref: "#/definitions/service-instance"
+ service-subscription:
description: |
+ Object that group service instances.
###### Related Nodes
- - FROM l3-network
- - FROM allotted-resource
+ - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
required:
- - network-policy-id
+ - service-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: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
type: string
- description: ID for the openStack Heat instance
+ 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: "#/definitions/service-instance"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- network-policies:
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
properties:
- network-policy:
+ service-subscription:
type: array
items:
- $ref: "#/definitions/network-policy"
- vf-module:
+ $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: |
- a deployment unit of VNFCs
###### Related Nodes
- - TO volume-group (One2One)
- - TO l3-network (Many2Many)
- - TO vnfc (One2Many)
- - FROM vserver
- - FROM generic-vnf (is composed of vf-module)
+ - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
required:
- - vf-module-id
- - is-base-vf-module
+ - site-pair-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:
- type: string
- description: orchestration status of this vf-module, mastered by MSO
- is-base-vf-module:
- type: boolean
- resource-version:
+ site-pair-id:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- model-invariant-id:
+ description: unique identifier of probe
+ source-ip:
type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
+ description: Prefix address
+ destination-ip:
type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
+ description: Prefix address
+ ip-version:
type: string
- description: the ASDC model version for this resource or service model.
- model-customization-id:
+ description: ip version, v4, v6
+ destination-hostname:
type: string
- description: captures the id of all the configuration used to customize the resource for the service.
- widget-model-id:
+ description: Hostname of the destination equipment to which SLAs are measured against.
+ destination-equip-type:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: The type of destinatination equipment. Could be Router, UCPE, etc.
+ 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.
- contrail-service-instance-fqdn:
+ 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 org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
type: string
- description: the Contrail unique ID for a service-instance
- module-index:
- type: integer
- format: int32
- description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
- selflink:
+ description: Unique id of site pair set.
+ resource-version:
type: string
- description: Path to the controller object.
+ 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"
- vf-modules:
+ site-pair-sets:
description: |
- Collection of vf-modules, a deployment unit of VNFCs
+ Collection of sets of instances for probes related to generic-vnf
properties:
- vf-module:
+ site-pair-set:
type: array
items:
- $ref: "#/definitions/vf-module"
- generic-vnf:
+ $ref: "#/definitions/site-pair-set"
+ site-pairs:
description: |
- General purpose VNF
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
###### 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 pnf (Many2Many)
- - TO ipsec-configuration (Many2One)
- - TO vf-module (comprises generic-vnf, One2Many)
- - TO volume-group (One2Many)
- - TO vnfc (One2Many)
- - TO instance-group (Many2Many)
- - TO entitlement (comprises generic-vnf, One2Many)
- - TO license (comprises generic-vnf, One2Many)
- - TO complex (Many2Many)
- - TO ctag-pool (Many2Many)
- - FROM line-of-business
- - FROM platform
- - FROM virtual-data-center
- - FROM logical-link
- - FROM allotted-resource
+ - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
required:
- - vnf-id
- - vnf-name
- - vnf-type
- - in-maint
- - is-closed-loop-disabled
+ - snapshot-id
properties:
- vnf-id:
+ snapshot-id:
type: string
- description: Unique id of VNF. This is unique across the graph.
- vnf-name:
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ snapshot-name:
type: string
- description: Name of VNF.
- vnf-name2:
+ description: Snapshot name
+ snapshot-architecture:
type: string
- description: Alternate name of VNF.
- vnf-type:
- type: string
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- service-id:
- type: string
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- regional-resource-zone:
- type: string
- description: Regional way of organizing pservers, source of truth should define values
- prov-status:
- type: string
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- operational-status:
- type: string
- description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
- license-key:
+ description: Operating system architecture
+ snapshot-os-distro:
type: string
- description: OBSOLETE - do not use
- equipment-role:
+ description: The common name of the operating system distribution in lowercase
+ snapshot-os-version:
type: string
- description: Client should send valid enumerated value
- orchestration-status:
+ description: The operating system version as specified by the distributor.
+ application:
type: string
- description: Orchestration status of this VNF, used by MSO.
- heat-stack-id:
+ description: The application that the image instantiates.
+ application-vendor:
type: string
- description: Heat stack id corresponding to this instance, managed by MSO
- mso-catalog-key:
+ description: The vendor of the application.
+ application-version:
type: string
- description: Corresponds to the SDN-C catalog id used to configure this VCE
- management-option:
+ description: The version of the application.
+ snapshot-selflink:
type: string
- description: identifier of managed by ATT or customer
- ipv4-oam-address:
+ description: URL to endpoint where AAI can get more details
+ prev-snapshot-id:
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: This field contains the UUID of the previous snapshot (if any).
+ resource-version:
type: string
- description: v4 Loopback0 address
- nm-lan-v6-address:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/definitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pf-pci-id
+ properties:
+ pf-pci-id:
type: string
- description: v6 Loopback address
- management-v6-address:
+ description: Identifier for the sriov-pf
+ resource-version:
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, to be used only by uCPE
- vcpu-units:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pci-id
+ properties:
+ pci-id:
type: string
- description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
- vmemory:
- type: integer
- format: int64
- description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
- vmemory-units:
+ description: PCI ID used to identify the sriov-vf
+ vf-vlan-filter:
type: string
- description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
- vdisk:
- type: integer
- format: int64
- description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
- vdisk-units:
+ 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: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
- in-maint:
+ 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
- is-closed-loop-disabled:
+ 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
- resource-version:
- type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- summary-status:
+ 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: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
- encrypted-access-flag:
+ 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: indicates whether generic-vnf access uses SSH
- entitlement-assignment-group-uuid:
+ 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: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
- entitlement-resource-uuid:
+ 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: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
- license-assignment-group-uuid:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
type: string
- description: UUID of the license assignment group. OBSOLETE - See child relationships.
- license-key-uuid:
+ description: Neutron network id of the interface
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
type: string
- description: UUID of the actual license resource. OBSOLETE - See child relationships.
- model-invariant-id:
+ property-value:
type: string
- description: the ASDC model id for this resource or service model.
- model-version-id:
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ required:
+ - subnet-id
+ - dhcp-enabled
+ properties:
+ subnet-id:
type: string
- description: the ASDC model version for this resource or service model.
- persona-model-version:
+ description: Subnet ID, should be UUID.
+ subnet-name:
type: string
- description: the ASDC model version for this resource or service model.
- model-customization-id:
+ description: Name associated with the subnet.
+ neutron-subnet-id:
type: string
- description: captures the id of all the configuration used to customize the resource for the service.
- widget-model-id:
+ description: Neutron id of this subnet
+ gateway-address:
type: string
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- widget-model-version:
+ description: gateway ip address
+ network-start-address:
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: network start address
+ cidr-mask:
type: string
- description: as-number of the VNF
- regional-resource-subzone:
+ description: cidr mask
+ ip-version:
type: string
- description: represents sub zone of the rr plane
- nf-type:
+ description: ip version
+ orchestration-status:
type: string
- description: Generic description of the type of NF
- nf-function:
+ description: Orchestration status of this VNF, mastered by MSO
+ dhcp-enabled:
+ type: boolean
+ dhcp-start:
type: string
- description: English description of Network function that the specific VNF deployment is providing
- nf-role:
+ description: the start address reserved for use by dhcp
+ dhcp-end:
type: string
- description: role in the network that this model will be providing
- nf-naming-code:
+ description: the last address reserved for use by dhcp
+ subnet-role:
type: string
- description: string assigned to this model used for naming purposes
- selflink:
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
type: string
- description: Path to the controller object.
- ipv4-oam-gateway-address:
+ description: ip address assignment direction of the subnet
+ resource-version:
type: string
- description: Gateway address
- ipv4-oam-gateway-address-prefix-length:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
type: integer
format: int32
- description: Prefix length for oam-address
- vlan-id-outer:
- type: integer
- format: int64
- description: Temporary location for S-TAG to get to VCE
- nm-profile-name:
- type: string
- description: Network Management profile of this VNF
- relationship-list:
+ description: sequence of the subnet
+ host-routes:
type: array
items:
- $ref: "#/definitions/relationship"
- l-interfaces:
+ $ref: "#/definitions/host-route"
+ relationship-list:
type: array
items:
- $ref: "#/definitions/l-interface"
- lag-interfaces:
+ $ref: "#/definitions/relationship"
+ subnets:
+ properties:
+ subnet:
type: array
- items:
- $ref: "#/definitions/lag-interface"
- vf-modules:
+ items:
+ $ref: "#/definitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
type: array
- items:
- $ref: "#/definitions/vf-module"
- licenses:
+ items:
+ $ref: "#/definitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked 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
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
type: array
items:
- $ref: "#/definitions/license"
- entitlements:
+ $ref: "#/definitions/vserver"
+ relationship-list:
type: array
items:
- $ref: "#/definitions/entitlement"
- generic-vnfs:
+ $ref: "#/definitions/relationship"
+ tenants:
description: |
- Collection of VNFs
+ Collection of openstack tenants.
properties:
- generic-vnf:
+ tenant:
type: array
items:
- $ref: "#/definitions/generic-vnf"
- lag-link:
+ $ref: "#/definitions/tenant"
+ tunnel-xconnect:
description: |
- LAG links can connect lag-interfaces
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
###### Related Nodes
- - FROM lag-interface
- - FROM logical-link
+ - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
required:
- - link-name
+ - id
+ - bandwidth-up-wan1
+ - bandwidth-down-wan1
+ - bandwidth-up-wan2
+ - bandwidth-down-wan2
properties:
- link-name:
+ id:
type: string
- description: Alphabetical concatenation of lag-interface names
+ 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: 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"
- lag-links:
+ tunnel-xconnects:
description: |
- Collection of link aggregation connections
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
properties:
- lag-link:
+ tunnel-xconnect:
type: array
items:
- $ref: "#/definitions/lag-link"
- newvce:
+ $ref: "#/definitions/tunnel-xconnect"
+ update:
description: |
- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ 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: "#/definitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/definitions/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 l-interface (comprises newvce, Many2Many)
+ - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
required:
- - vnf-id2
+ - vnf-id
- vnf-name
- vnf-type
properties:
- vnf-id2:
+ vnf-id:
type: string
- description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ description: Unique id of VNF. This is unique across the graph.
vnf-name:
type: string
description: Name of VNF.
vnf-type:
type: string
description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
prov-status:
type: string
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
operational-status:
type: string
description: Indicator for whether the resource is considered operational
license-key:
type: string
description: OBSOLETE - do not use
- 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
+ description: Network role being played by this VNF
orchestration-status:
type: string
- description: Orchestration status of this VNF, mastered by MSO.
+ 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:
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: Loopback0 address
+ entitlement-resource-uuid:
+ type: string
+ description: OBSOLETE - see child relationships
+ port-groups:
type: array
items:
- $ref: "#/definitions/relationship"
- l-interfaces:
+ $ref: "#/definitions/port-group"
+ licenses:
type: array
items:
- $ref: "#/definitions/l-interface"
- newvces:
+ $ref: "#/definitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/definitions/entitlement"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vces:
description: |
- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
properties:
- newvce:
+ vce:
type: array
items:
- $ref: "#/definitions/newvce"
- pnf:
+ $ref: "#/definitions/vce"
+ vf-module:
description: |
- PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
+ a deployment unit of VNFCs
###### Related Nodes
- - TO p-interface (comprises pnf, Many2Many)
- - TO lag-interface (comprises pnf, One2Many)
- - TO complex (Many2One)
- - TO instance-group (Many2Many)
- - TO zone (Many2One)
- - FROM esr-thirdparty-sdnc
- - FROM generic-vnf
- - FROM logical-link
- - FROM service-instance
+ - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - VF-MODULE cannot be deleted if linked to VNFC
required:
- - pnf-name
- - in-maint
+ - vf-module-id
+ - is-base-vf-module
properties:
- pnf-name:
- type: string
- description: unique name of Physical Network Function.
- pnf-name2:
+ vf-module-id:
type: string
- description: name of Physical Network Function.
- pnf-name2-source:
+ description: Unique ID of vf-module.
+ vf-module-name:
type: string
- description: source of name2
- pnf-id:
+ description: Name of vf-module
+ heat-stack-id:
type: string
- description: id of pnf
- equip-type:
+ description: Heat stack id corresponding to this instance.
+ orchestration-status:
type: string
- description: Equipment type. Source of truth should define valid values.
- equip-vendor:
+ description: orchestration status of this vf-module, mastered by MSO
+ is-base-vf-module:
+ type: boolean
+ resource-version:
type: string
- description: Equipment vendor. Source of truth should define valid values.
- equip-model:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
type: string
- description: Equipment model. Source of truth should define valid values.
- management-option:
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
type: string
- description: identifier of managed by ATT or customer
- ipaddress-v4-oam:
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
type: string
- description: ipv4-oam-address with new naming convention for IP addresses
- sw-version:
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
type: string
- description: sw-version is the version of SW for the hosted application on the PNF.
- in-maint:
- type: boolean
- frame-id:
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
type: string
- description: ID of the physical frame (relay rack) where pnf is installed.
- serial-number:
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
type: string
- description: Serial number of the device
- ipaddress-v4-loopback-0:
+ 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: IPV4 Loopback 0 address
- ipaddress-v6-loopback-0:
+ description: the Contrail unique ID for a service-instance
+ module-index:
+ type: integer
+ format: int32
+ description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
+ selflink:
type: string
- description: IPV6 Loopback 0 address
- ipaddress-v4-aim:
+ description: Path to the controller object.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/definitions/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 org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ required:
+ - vig-address-type
+ properties:
+ vig-address-type:
type: string
- description: IPV4 AIM address
- ipaddress-v6-aim:
+ description: indicates whether the VIG is for AVPN or INTERNET
+ ipaddress-v4-vig:
type: string
- description: IPV6 AIM address
- ipaddress-v6-oam:
+ description: v4 IP of the vig server
+ ipaddress-v6-vig:
type: string
- description: IPV6 OAM address
- inv-status:
+ description: v6 IP of the vig server
+ resource-version:
type: string
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/definitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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.
- prov-status:
+ neutron-network-id:
type: string
- description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
- nf-role:
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
type: string
- description: Nf Role is the role performed by this instance in the network.
+ description: Neutron id of subnet that address belongs to
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- p-interfaces:
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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: "#/definitions/p-interface"
- lag-interfaces:
+ $ref: "#/definitions/relationship"
+ virtual-data-center:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ ###### Related Nodes
+ - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.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: "#/definitions/lag-interface"
- pnfs:
+ $ref: "#/definitions/relationship"
+ virtual-data-centers:
description: |
- Collection of Physical Network Functions.
+ Virtual organization of cloud infrastructure elements in a data center context
properties:
- pnf:
+ virtual-data-center:
type: array
items:
- $ref: "#/definitions/pnf"
- physical-link:
+ $ref: "#/definitions/virtual-data-center"
+ vlan:
description: |
- Collection of physical connections, typically between p-interfaces
+ Definition of vlan
###### Related Nodes
- - FROM p-interface
+ - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
required:
- - link-name
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
properties:
- link-name:
+ vlan-interface:
type: string
- description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ 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
- circuit-id:
- type: string
- description: Circuit it
- dual-mode:
- type: string
- description: Dual access mode (e.g., primary, secondary
- management-option:
+ vlan-description:
type: string
- description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
- service-provider-name:
+ description: Used to describe (the service associated with) the vlan
+ backdoor-connection:
type: string
- description: Name of the service Provider on this link.
- service-provider-bandwidth-up-value:
- type: integer
- format: int32
- description: Upstream Bandwidth value agreed with the service provider
- service-provider-bandwidth-up-units:
+ description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
+ vpn-key:
type: string
- description: Units for the upstream BW value
- service-provider-bandwidth-down-value:
- type: integer
- format: int32
- description: Downstream Bandwidth value agreed with the service provider
- service-provider-bandwidth-down-units:
+ description: This indicates the customers VPN ID associated with this vlan
+ orchestration-status:
type: string
- description: Units for downstream BW value
- resource-version:
+ description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
+ in-maint:
+ type: boolean
+ prov-status:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- physical-links:
- description: |
- Collection of physical connections, typically between p-interfaces
+ 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"
+ vlans:
properties:
- physical-link:
+ vlan:
type: array
items:
- $ref: "#/definitions/physical-link"
- vig-server:
+ $ref: "#/definitions/vlan"
+ vnf:
description: |
- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ 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 ipsec-configuration (is composed of vig-server)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
required:
- - vig-address-type
+ - vnf-image-uuid
+ - application
+ - application-vendor
properties:
- vig-address-type:
+ vnf-image-uuid:
type: string
- description: indicates whether the VIG is for AVPN or INTERNET
- ipaddress-v4-vig:
+ description: Unique ID of this asset
+ application:
type: string
- description: v4 IP of the vig server
- ipaddress-v6-vig:
+ description: The application that the image instantiates.
+ application-vendor:
type: string
- description: v6 IP of the vig server
+ 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.
type: array
items:
$ref: "#/definitions/relationship"
- vig-servers:
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
properties:
- vig-server:
+ vnf-image:
type: array
items:
- $ref: "#/definitions/vig-server"
- ipsec-configuration:
+ $ref: "#/definitions/vnf-image"
+ vnfc:
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
+ - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
required:
- - ipsec-configuration-id
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
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: ATT 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:
+ vnfc-name:
type: string
- description: Lifetime for IKEv1 SA
- ipsec-authentication:
+ description: Unique ID of vnfc.
+ nfc-naming-code:
type: string
- description: md5, sha1, sha256, sha384
- ipsec-encryption:
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
type: string
- description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
- ipsec-sa-lifetime:
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
type: string
- description: Life time for IPSec SA
- ipsec-pfs:
+ description: prov status of this vnfc
+ orchestration-status:
type: string
- description: enable PFS or not
- xauth-userid:
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
type: string
- description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
- xauth-user-password:
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
type: string
- description: Encrypted using the Juniper $9$ algorithm
- dpd-interval:
+ description: Group notation of VNFC
+ model-invariant-id:
type: string
- description: The time between DPD probe
- dpd-frequency:
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
type: string
- description: Maximum number of DPD before claiming the tunnel is down
+ description: the ASDC model version for this resource or service model.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
- vig-servers:
+ l3-interface-ipv4-address-list:
type: array
- items:
- $ref: "#/definitions/vig-server"
- ipsec-configurations:
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
properties:
- ipsec-configuration:
+ vnfc:
type: array
items:
- $ref: "#/definitions/ipsec-configuration"
- route-table-reference:
+ $ref: "#/definitions/vnfc"
+ volume:
description: |
- Openstack route table reference.
+ Ephemeral Block storage volume.
###### Related Nodes
- - FROM l3-network
+ - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
required:
- - route-table-reference-id
- - route-table-reference-fqdn
+ - volume-id
+ - volume-selflink
properties:
- route-table-reference-id:
+ volume-id:
type: string
- description: Route Table Reference id, UUID assigned to this instance.
- route-table-reference-fqdn:
+ description: Unique ID of block storage volume relative to the vserver.
+ volume-selflink:
type: string
- description: FQDN entry in the route table.
+ description: URL to endpoint where AAI can get more details
resource-version:
type: string
- description: Concurrency value
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- route-table-references:
- description: |
- Collection of openstack route table references
- properties:
- route-table-reference:
- type: array
- items:
- $ref: "#/definitions/route-table-reference"
- instance-group:
+ volume-group:
description: |
- General mechanism for grouping instances
+ Persistent block-level storage.
###### Related Nodes
- - TO model (Many2Many)
- - FROM l-interface
- - FROM vnfc
- - FROM l3-interface-ipv4-address-list
- - FROM l3-interface-ipv6-address-list
- - FROM l3-network
- - FROM pnf
- - FROM allotted-resource
- - FROM generic-vnf
- - FROM service-instance
+ - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
required:
- - instance-group-role
- - model-invariant-id
- - model-version-id
- - id
- - description
- - type
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
properties:
- instance-group-role:
+ volume-group-id:
type: string
- description: role of the instance group.
- model-invariant-id:
+ description: Unique ID of volume-group.
+ volume-group-name:
type: string
- description: ASDC model id for this resource or service model.
- model-version-id:
+ description: Name of the volume group.
+ heat-stack-id:
type: string
- description: ASDC model version uid for this resource model.
- id:
+ description: Heat stack id corresponding to this volume-group
+ vnf-type:
type: string
- description: Instance Group ID, UUID assigned to this instance.
- description:
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
type: string
- description: Descriptive text to help identify the usage of this instance-group
- type:
+ description: Orchestration status of this volume-group
+ model-customization-id:
type: string
- description: Only valid value today is lower case ha for high availability
- sub-type:
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
type: string
- description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ description: helps relate the volume group to the vf-module whose components will require the volume group
resource-version:
type: string
- description: Concurrency value
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- instance-groups:
+ volume-groups:
description: |
- Collection of openstack route table references
+ Collection of persistent block-level storage.
properties:
- instance-group:
+ volume-group:
type: array
items:
- $ref: "#/definitions/instance-group"
- zone:
+ $ref: "#/definitions/volume-group"
+ volumes:
description: |
- A zone is a grouping of assets in a location homing to the same connections into the CBB
+ 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 (Many2One)
- - FROM cloud-region
- - FROM pserver
- - FROM pnf
- - FROM service-instance
+ - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
required:
- - zone-id
- - zone-name
- - design-type
- - zone-context
+ - equipment-name
properties:
- zone-id:
- type: string
- description: Code assigned by AIC to the zone
- zone-name:
+ equipment-name:
type: string
- description: English name associated with the zone
- design-type:
+ prov-status:
type: string
- description: Design of zone [Medium/Large?]
- zone-context:
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ ipv4-oam-address:
type: string
- description: Context of zone [production/test]
- status:
+ 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: Status of a zone.
+ 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: Concurrency value
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- zones:
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ vpls-pes:
description: |
- Collection of zones
+ Collection of VPLS Provider Edge routers
properties:
- zone:
+ vpls-pe:
type: array
items:
- $ref: "#/definitions/zone"
- vip-ipv4-address-list:
+ $ref: "#/definitions/vpls-pe"
+ vpn-binding:
description: |
- IPv4 Address Range
+ VPN binding
###### Related Nodes
- - FROM vnfc
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
required:
- - vip-ipv4-address
+ - vpn-id
+ - vpn-name
properties:
- vip-ipv4-address:
+ vpn-id:
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:
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
type: string
- description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
- neutron-network-id:
+ description: VPN Name
+ vpn-platform:
type: string
- description: Neutron network id of the interface that address belongs to
- neutron-subnet-id:
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
type: string
- description: Neutron id of subnet that address belongs to
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ route-targets:
+ type: array
+ items:
+ $ref: "#/definitions/route-target"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- vip-ipv6-address-list:
+ description: l3-networks relate to vpn-bindings
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/definitions/vpn-binding"
+ vserver:
description: |
- IPv6 Address Range
+ Virtual Servers, aka virtual machine or VM.
###### Related Nodes
- - FROM vnfc
+ - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
required:
- - vip-ipv6-address
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
properties:
- vip-ipv6-address:
+ vserver-id:
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:
+ 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
+ is-closed-loop-disabled:
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/relationship"
- network:
- description: |
- Namespace for network inventory resources.
- 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:
- type: array
- items:
- $ref: "#/definitions/route-table-reference"
- instance-groups:
+ volumes:
type: array
items:
- $ref: "#/definitions/instance-group"
- zones:
+ $ref: "#/definitions/volume"
+ relationship-list:
type: array
items:
- $ref: "#/definitions/zone"
- vip-ipv4-address-list:
- type: object
- $ref: "#/definitions/vip-ipv4-address-list"
- vip-ipv6-address-list:
- type: object
- $ref: "#/definitions/vip-ipv6-address-list"
- inventory:
- properties:
- search:
- type: object
- $ref: "#/definitions/search"
- actions:
- type: object
- $ref: "#/definitions/actions"
- cloud-infrastructure:
- type: object
- $ref: "#/definitions/cloud-infrastructure"
- external-system:
- type: object
- $ref: "#/definitions/external-system"
- 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"
- nodes:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
type: array
items:
- $ref: "#/definitions/"
- edge-tag-query-result:
- properties:
- tagged-inventory-item-list:
- type: array
- items:
- $ref: "#/definitions/tagged-inventory-item-list"
- tagged-inventory-item-list:
+ $ref: "#/definitions/l-interface"
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
properties:
- inventory-item:
+ vserver:
type: array
items:
- $ref: "#/definitions/inventory-item"
- inventory-item:
+ $ref: "#/definitions/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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
properties:
- inventory-item-type:
+ zone-id:
type: string
- inventory-item-link:
+ description: Code assigned by AIC to the zone
+ zone-name:
type: string
- inventory-item-data:
+ 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/inventory-item-data"
- tagged-inventory-item-list:
+ items:
+ $ref: "#/definitions/relationship"
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
type: array
items:
- $ref: "#/definitions/tagged-inventory-item-list"
- inventory-item-data:
+ $ref: "#/definitions/zone"
+patchDefinitions:
+ aai-internal:
properties:
property-name:
type: string
property-value:
type: string
- edge-tag-query-request:
+ action:
properties:
- edge-tag:
- type: string
- result-detail:
- type: string
- start-node-type:
+ action-type:
type: string
- start-node-filter:
- type: array
- items:
- $ref: "#/definitions/start-node-filter"
- include-node-filter:
- type: array
- items:
- $ref: "#/definitions/include-node-filter"
- secondary-filter:
+ action-data:
type: array
items:
- $ref: "#/definitions/secondary-filter"
- start-node-filter:
+ $ref: "#/patchDefinitions/action-data"
+ action-data:
properties:
property-name:
type: string
property-value:
type: string
- include-node-filter:
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
properties:
- include-node-type:
- type: string
- secondary-filter:
+ update:
+ type: object
+ $ref: "#/patchDefinitions/update"
+ notify:
+ type: object
+ $ref: "#/patchDefinitions/notify"
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ required:
+ - id
properties:
- property-name:
+ id:
type: string
- filter-type:
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
type: string
- property-value:
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
type: string
- search-results:
+ description: Link back to more information in the controller
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
properties:
- result-data:
+ allotted-resource:
type: array
items:
- $ref: "#/definitions/result-data"
- result-data:
+ $ref: "#/patchDefinitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+ required:
+ - availability-zone-name
+ - hypervisor-type
properties:
- resource-type:
+ availability-zone-name:
type: string
- description: The specific type of node in the A&AI graph
- resource-link:
+ description: Name of the availability zone. Unique across a cloud region
+ hypervisor-type:
type: string
- description: The URL to the specific resource
- sdn-zone-response:
+ description: Type of hypervisor. Source of truth should define valid values.
+ operational-status:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ availability-zones:
+ description: |
+ Collection of availability zones
properties:
- oam-networks:
- type: object
- $ref: "#/definitions/oam-networks"
- az-and-dvs-switches:
+ availability-zone:
type: array
items:
- $ref: "#/definitions/az-and-dvs-switches"
+ $ref: "#/patchDefinitions/availability-zone"
az-and-dvs-switches:
properties:
dvs-switches:
type: object
- $ref: "#/definitions/dvs-switches"
+ $ref: "#/patchDefinitions/dvs-switches"
availability-zone:
type: object
- $ref: "#/definitions/availability-zone"
- update:
+ $ref: "#/patchDefinitions/availability-zone"
+ business:
description: |
- Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
- required:
- - update-node-type
+ Namespace for business related constructs
properties:
- update-node-type:
- type: string
- update-node-key:
+ connectors:
type: array
- items:
- $ref: "#/definitions/update-node-key"
- update-node-uri:
- type: string
- action:
+ items:
+ $ref: "#/patchDefinitions/connector"
+ customers:
type: array
- items:
- $ref: "#/definitions/action"
- action:
- properties:
- action-type:
- type: string
- action-data:
+ items:
+ $ref: "#/patchDefinitions/customer"
+ lines-of-business:
type: array
- items:
- $ref: "#/definitions/action-data"
- action-data:
- properties:
- property-name:
- type: string
- property-value:
- type: string
- update-node-key:
- properties:
- key-name:
- type: string
- key-value:
- type: string
- notify:
+ items:
+ $ref: "#/patchDefinitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/project"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
required:
- - event-id
+ - cos
properties:
- event-id:
+ cos:
type: string
- node-type:
+ description: unique identifier of probe
+ probe-id:
type: string
- event-trigger:
+ description: identifier of probe
+ probe-type:
type: string
- key-data:
+ description: type of probe
+ classes-of-service:
+ description: |
+ class-of-service of probe
+ properties:
+ class-of-service:
type: array
items:
- $ref: "#/definitions/key-data"
- selflink:
- type: string
- key-data:
- properties:
- key-name:
- type: string
- key-value:
- type: string
- notification-event:
+ $ref: "#/patchDefinitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
properties:
- cambria.partition:
- type: string
- notification-event-header:
- type: object
- $ref: "#/definitions/notification-event-header"
- notification-event-header:
+ 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
properties:
- id:
- type: string
- timestamp:
+ cloud-owner:
type: string
- source-name:
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
type: string
- domain:
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
type: string
- sequence-number:
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
type: string
- severity:
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
type: string
- event-type:
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
type: string
- version:
+ description: URL of the keystone identity service
+ cloud-zone:
type: string
- action:
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
type: string
- entity-type:
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
+ type: boolean
+ cloud-extra-info:
type: string
- top-entity-type:
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
type: string
- entity-link:
+ description: MultiVIM will discover and expose EPA capabilities.
+ 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 org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ properties:
+ physical-location-id:
type: string
- status:
+ description: Unique identifier for physical location, e.g., CLLI
+ data-center-code:
type: string
- reserved-prop-names:
+ 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: |
- Internal map to define some reserved properties of a vertex
+ Collection of physical locations that can house cloud-regions.
properties:
- last-mod-source-of-truth:
+ complex:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ configuration-id:
type: string
- aai-node-type:
+ description: UUID assigned to configuration.
+ management-option:
type: string
- aai-created-ts:
+ 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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
+ 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 org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
type: integer
format: int64
- aai-unique-key:
+ 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 org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ properties:
+ target-pe:
type: string
- aai-last-mod-ts:
+ 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ 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
- source-of-truth:
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
type: string
- aai-uri:
+ 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
type: string
prevent-delete:
type: string
- model-and-named-query-search:
+ 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: |
- ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
properties:
- query-parameters:
- type: object
- $ref: "#/definitions/query-parameters"
- instance-filters:
- type: object
- $ref: "#/definitions/instance-filters"
- secondary-filts:
- type: object
- $ref: "#/definitions/secondary-filts"
- top-node-type:
+ element-choice-set-uuid:
type: string
- secondary-filter-cut-point:
+ element-choice-set-name:
type: string
- query-parameters:
+ cardinality:
+ type: string
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/element-choice-set"
+ entitlement:
description: |
- QueryParameters for performing a named-query or model query
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
properties:
- named-query:
- type: object
- $ref: "#/definitions/named-query"
- overloaded-model:
- type: object
- $ref: "#/definitions/overloaded-model"
- overloaded-model:
+ 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: |
- Allows for legacy POST of old-style and new-style models
+ 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
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
- - model-invariant-id
- - model-name-version-id
- - model-type
- - model-name
- - model-id
- - model-version
+ - ems-id
properties:
- model-invariant-id:
+ ems-id:
type: string
- description: Unique identifier corresponding to the main definition of a model in ASDC
- model-name-version-id:
+ 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
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
type: string
- description: Unique identifier corresponding to one version of a model in ASDC
- model-type:
+ description: Unique ID of esr system info.
+ system-name:
type: string
- description: Type of the model, e.g., service, resource, widget, etc.
- model-name:
+ description: name of external system.
+ type:
type: string
- description: Name of the model, which can change from version to version.
- model-id:
+ description: type of external systems.
+ vendor:
type: string
- description: Invariant unique ID which does not change from version to version
- model-version:
+ description: vendor of external systems.
+ version:
type: string
- description: Version
- model-description:
+ description: version of external systems.
+ service-url:
type: string
- description: Description
- resource-version:
+ description: url used to access external systems.
+ user-name:
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: object
- $ref: "#/definitions/relationship-list"
- instance-filters:
+ 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: |
- InstanceFilters for performing a named-query or model query
+ Collection of persistent block-level external system auth info.
properties:
- instance-filter:
+ esr-system-info:
type: array
items:
- $ref: "#/definitions/instance-filter"
- instance-filter:
- description: |
- InstanceFilter for performing a named-query or model query
- secondary-filts:
+ $ref: "#/patchDefinitions/esr-system-info"
+ esr-thirdparty-sdnc:
description: |
- SecondaryFilts for performing a named-query or model query
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - thirdparty-sdnc-id
properties:
- secondary-filt:
+ 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: "#/definitions/secondary-filt"
- secondary-filt:
- description: |
- SecondaryFilt for performing a named-query or model query
- properties:
+ $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
+ esr-vnfm:
description: |
- Property holder for query properties or instance properties
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - vnfm-id
properties:
- property-name:
+ vnfm-id:
type: string
- property-value:
+ description: Unique ID of VNFM.
+ vim-id:
type: string
- response-list:
- description: |
- Response container for the results of a named-query or model query
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
+ type: string
+ description: certificate url of VNFM.
+ esr-vnfm-list:
properties:
- inventory-response-items:
- type: object
- $ref: "#/definitions/inventory-response-items"
- inventory-response-items:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-vnfm"
+ evc:
description: |
- Container for inventory items in response list
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - evc-id
properties:
- inventory-response-item:
+ 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: "#/definitions/inventory-response-item"
- inventory-response-item:
+ $ref: "#/patchDefinitions/evc"
+ external-system:
description: |
- Inventory item for response list
+ Namespace for external system.
properties:
- model-name:
- type: string
- extra-properties:
+ esr-ems-list:
type: object
- $ref: "#/definitions/extra-properties"
- inventory-response-items:
+ $ref: "#/patchDefinitions/esr-ems-list"
+ esr-vnfm-list:
type: object
- $ref: "#/definitions/inventory-response-items"
+ $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:
type: array
items:
- $ref: "#/definitions/extra-property"
+ $ref: "#/patchDefinitions/extra-property"
extra-property:
properties:
property-name:
type: string
property-value:
type: string
- vnf:
+ flavor:
description: |
- Abstract vnf class
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked to VSERVER
required:
- - vnf-id
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
properties:
- vnf-id:
+ flavor-id:
type: string
- description: Unique id of VNF. This is unique across the graph.
+ 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 org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ 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 org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
+ type: string
+ description: vnf instance id.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
+ type: string
+ vnf-discriptor-name:
+ type: string
+ description: vnf discriptor name
+ job-id:
+ type: string
+ description: job id corresponding to vnf
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT 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, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
+ - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
+ 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 org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
+ 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 org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
+ - id
+ - description
+ - type
+ properties:
+ instance-group-role:
+ type: string
+ description: role of the instance group.
+ model-invariant-id:
+ type: string
+ description: ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: ASDC model version uid for this resource model.
+ 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"
+ external-system:
+ type: object
+ $ref: "#/patchDefinitions/external-system"
+ business:
+ type: object
+ $ref: "#/patchDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/patchDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/patchDefinitions/network"
+ aai-internal:
+ type: object
+ $ref: "#/patchDefinitions/aai-internal"
+ nodes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/aai-internal"
+ 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 org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ 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: ATT 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,ucpeHostName,nmteHostName
+ xauth-user-password:
+ type: string
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
+ type: string
+ description: The time between DPD probe
+ dpd-frequency:
+ type: string
+ description: Maximum number of DPD before claiming the tunnel is down
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ interface-name:
+ type: string
+ description: Name given to the interface
+ interface-role:
+ type: string
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
+ type: string
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
+ 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 instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ 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 instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ 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 instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ 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
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this 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 tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ 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 org.onap.relationships.inventory.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 cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ required:
+ - link-name
+ - in-maint
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ 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 configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ 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, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ 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"
+ secondary-filts:
+ type: object
+ $ref: "#/patchDefinitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ 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 org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ 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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ 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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ 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"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/configurations"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
+ 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"
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ 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.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
+ 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 tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ 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.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
+ 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 org.onap.relationships.inventory.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. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ 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 ATT 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.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ 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 org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ 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 org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to 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
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
+ type: string
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
+ 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"
+ overloaded-model:
+ type: object
+ $ref: "#/patchDefinitions/overloaded-model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ 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
+ aai-uri:
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ 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. Does not strictly map to ASDC services.
+ 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 org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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 org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
+ type: string
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
+ type: string
+ description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ 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 org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ 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, UCPE, etc.
+ site-pair-set:
+ description: |
+ Set of instances for probes used to measure service level agreements
+ ###### Related Nodes
+ - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ 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
+ dhcp-start:
+ type: string
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
+ subnet-role:
+ type: string
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked 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
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ 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 org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Network role being played by this VNF
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - VF-MODULE cannot be deleted if linked 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
+ 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 org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
+ 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 org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ required:
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ nfc-naming-code:
+ type: string
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
+ type: string
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
+ type: string
+ description: prov status of this vnfc
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
+ type: string
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
+ type: string
+ description: Group notation of VNFC
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ 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 tosca.relationships.AttachesTo volume)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
+ type: string
+ description: helps relate the volume group to the vf-module whose components will require the volume group
+ 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ 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 allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ required:
+ - vpn-id
+ - vpn-name
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
+ type: string
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ 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 org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ 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
+ is-closed-loop-disabled:
+ type: boolean
+ 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.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:
+ aai-internal:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ 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 allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ 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
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ resource-version:
+ type: string
+ description: Concurrency value
+ orchestration-status:
+ type: string
+ description: Orchestration status
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ type:
+ type: string
+ description: Generic description of the type of allotted resource.
+ role:
+ type: string
+ description: role in the network that this resource will be providing.
+ 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked 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-status:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/getDefinitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/getDefinitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/getDefinitions/project"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
+ properties:
+ cloud-owner:
+ type: string
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
+ type: string
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
+ type: string
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
+ type: string
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
+ type: string
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
+ type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
+ 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"
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-system-info"
+ vip-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vip-ipv6-address-list"
+ 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 org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
+ 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 org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ 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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
+ 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.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ 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 org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ 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 org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.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
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
+ SVC-INFRA:
+ type: string
+ prevent-delete:
+ type: string
+ 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 org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ 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
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ 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
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ 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
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ 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
+ properties:
+ extra-property:
+ type: array
+ items:
+ $ref: "#/getDefinitions/extra-property"
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ 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 org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
+ type: string
+ description: vnf instance id.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
+ type: string
+ vnf-discriptor-name:
+ type: string
+ description: vnf discriptor name
+ job-id:
+ type: string
+ description: job id corresponding to vnf
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT 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, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ summary-status:
+ type: string
+ description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ entitlement-assignment-group-uuid:
+ type: string
+ description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
+ entitlement-resource-uuid:
+ type: string
+ description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
+ license-assignment-group-uuid:
+ type: string
+ description: UUID of the license assignment group. OBSOLETE - See child relationships.
+ license-key-uuid:
+ type: string
+ description: UUID of the actual license resource. OBSOLETE - See child relationships.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
+ nf-type:
+ type: string
+ description: Generic description of the type of NF
+ nf-function:
+ type: string
+ description: English description of Network function that the specific VNF deployment is providing
+ nf-role:
+ type: string
+ description: role in the network that this model will be providing
+ nf-naming-code:
+ type: string
+ description: string assigned to this model used for naming purposes
+ selflink:
+ type: string
+ description: Path to the controller object.
+ ipv4-oam-gateway-address:
+ type: string
+ description: Gateway address
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Prefix length for oam-address
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for S-TAG to get to VCE
+ nm-profile-name:
+ type: string
+ description: Network Management profile of this VNF
+ 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"
+ licenses:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
+ - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
+ 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 org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
+ 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 org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
+ - id
+ - description
+ - type
+ properties:
+ instance-group-role:
+ type: string
+ description: role of the instance group.
+ model-invariant-id:
+ type: string
+ description: ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: ASDC model version uid for this resource model.
+ 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"
+ external-system:
+ type: object
+ $ref: "#/getDefinitions/external-system"
+ business:
+ type: object
+ $ref: "#/getDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/getDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/getDefinitions/network"
+ aai-internal:
+ type: object
+ $ref: "#/getDefinitions/aai-internal"
+ nodes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/aai-internal"
+ 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 org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ 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: ATT 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,ucpeHostName,nmteHostName
+ xauth-user-password:
+ type: string
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
+ type: string
+ description: The time between DPD probe
+ dpd-frequency:
+ type: string
+ description: Maximum number of DPD before claiming the tunnel is down
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ interface-name:
+ type: string
+ description: Name given to the interface
+ interface-role:
+ type: string
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
+ type: string
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
+ vlans:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-vf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ 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 instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ 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 instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ 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 instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ 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
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ 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
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ physical-network-name:
+ type: string
+ description: Name associated with the physical network.
+ is-provider-network:
+ type: boolean
+ is-shared-network:
+ type: boolean
+ is-external-network:
+ type: boolean
+ selflink:
+ type: string
+ description: Path to the controller object.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ interface-id:
+ type: string
+ description: ID of interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ in-maint:
+ type: boolean
+ 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 tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ 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 org.onap.relationships.inventory.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 cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ required:
+ - link-name
+ - in-maint
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ link-type:
+ type: string
+ description: Type of logical link, e.g., evc
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ ip-version:
+ type: string
+ description: v4, v6, or ds for dual stack
+ routing-protocol:
+ type: string
+ description: For example, static or BGP
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ operational-status:
+ type: string
+ description: Indication of operational status of the logical link.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ link-role:
+ type: string
+ description: Indication of the network use of the logical link.
+ link-name2:
+ type: string
+ description: Alias or alternate name (CLCI or D1 name).
+ link-id:
+ type: string
+ description: UUID of the logical-link, SDNC generates this.
+ circuit-id:
+ type: string
+ description: Circuit id
+ purpose:
+ type: string
+ description: Reason for this entity, role it is playing
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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 configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ 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, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-ver"
+ 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"
+ secondary-filts:
+ type: object
+ $ref: "#/getDefinitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ 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"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ 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 org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ 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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ 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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ 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"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/getDefinitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/configurations"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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"
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ 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.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ inv-status:
+ type: string
+ description: inventory status
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ sriov-pfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-pf"
+ 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 tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ 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.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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 org.onap.relationships.inventory.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. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ 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 ATT 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.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ nf-role:
+ type: string
+ description: Nf Role is the role performed by this instance in the network.
+ 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 org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ 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 org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to 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
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
+ type: string
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ pserver-name2:
+ type: string
+ description: alternative pserver name
+ purpose:
+ type: string
+ description: purpose of pserver
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ management-option:
+ type: string
+ description: Indicates who owns and or manages the device.
+ host-profile:
+ type: string
+ description: The host profile that defines the configuration of the pserver.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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"
+ overloaded-model:
+ type: object
+ $ref: "#/getDefinitions/overloaded-model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ 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
+ aai-uri:
+ 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ 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. Does not strictly map to ASDC services.
+ 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 org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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 org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
+ type: string
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
+ type: string
+ description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ 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.
+ selflink:
+ type: string
+ description: Path to the controller object.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this service.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ allotted-resources:
+ type: array
+ items:
+ $ref: "#/getDefinitions/allotted-resource"
+ 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ 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 org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ 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, UCPE, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ classes-of-service:
+ type: array
+ items:
+ $ref: "#/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 org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ 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
+ dhcp-start:
+ type: string
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
+ subnet-role:
+ type: string
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/host-route"
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked 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
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
+ type: array
+ items:
+ $ref: "#/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 org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ 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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Network role being played by this VNF
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: Loopback0 address
+ entitlement-resource-uuid:
+ type: string
+ description: OBSOLETE - see child relationships
+ port-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/port-group"
+ licenses:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - VF-MODULE cannot be deleted if linked 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
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ contrail-service-instance-fqdn:
+ type: string
+ description: the Contrail unique ID for a service-instance
+ module-index:
+ type: integer
+ format: int32
+ description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
+ selflink:
+ type: string
+ description: Path to the controller object.
+ 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 org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
+ 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-key:
+ type: string
+ description: This indicates the customers VPN ID associated with this vlan
+ orchestration-status:
+ type: string
+ description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ 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 org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ required:
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ nfc-naming-code:
+ type: string
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
+ type: string
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
+ type: string
+ description: prov status of this vnfc
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
+ type: string
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
+ type: string
+ description: Group notation of VNFC
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ 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"
+ 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"
+ 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 tosca.relationships.AttachesTo volume)
+ 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
+ type: string
+ description: helps relate the volume group to the vf-module whose components will require the volume group
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ 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 allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ required:
+ - vpn-id
+ - vpn-name
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
+ type: string
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ route-targets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-target"
+ 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 org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ 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
+ is-closed-loop-disabled:
+ type: boolean
+ 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.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