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
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
- in: query
- description: URL of the keystone identity service
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/ctag-pool"
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
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
+ - name: availability-zone-name
in: query
- description: URL of the keystone identity service
+ description:
required: false
type: string
/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
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
- required: false
- type: string
- - name: complex-name
- in: query
- description: Gamma complex name for LCP instance.
- required: false
- type: string
- - name: identity-url
- in: query
- description: URL of the keystone identity service
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/complex"
$ref: "#/getDefinitions/complexes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: data-center-code
+ in: query
+ description:
+ required: false
+ type: string
+ - name: complex-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: identity-url
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __VOLUME-GROUP-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
- - name: volume-group-name
- in: query
- description: Name of the volume group.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this volume-group
- required: false
- type: string
- - name: vnf-type
- in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/volume-group"
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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
- consumes:
- - 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
- consumes:
- - 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__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
- get:
- tags:
- - CloudInfrastructure
- summary: returns volume
- description: returns volume
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/volume"
- "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: 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
+ - name: volume-group-id
in: query
- description: This field will store the tenant context.
+ description:
required: false
type: string
- - name: vserver-name
+ - name: volume-group-name
in: query
- description: Name of vserver
+ description:
required: false
type: string
- - name: vserver-name2
+ - name: heat-stack-id
in: query
- description: Alternative name of vserver
+ description:
required: false
type: string
- - name: prov-status
+ - name: vnf-type
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
- summary: create or update an existing volume
- description: |
- Create or update an existing volume.
- #
- Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
consumes:
- application/json
- application/xml
example: __VOLUME-ID__
- name: body
in: body
- description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
required: true
schema:
- $ref: "#/definitions/volume"
- patch:
+ $ref: "#/definitions/relationship"
+ delete:
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
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
consumes:
- application/json
- application/xml
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:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
+ get:
tags:
- CloudInfrastructure
- summary: delete an existing volume
- description: delete an existing volume
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
- consumes:
- - application/json
- - application/xml
+ summary: returns volume
+ description: returns volume
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volume"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __VOLUME-ID__
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
- get:
+ put:
tags:
- CloudInfrastructure
- summary: returns volumes
- description: returns volumes
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
+ summary: create or update an existing volume
+ description: |
+ Create or update an existing volume.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/volumes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __VSERVER-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
- - 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
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
- put:
+ example: __VOLUME-ID__
+ - name: body
+ in: body
+ description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
+ required: true
+ schema:
+ $ref: "#/definitions/volume"
+ patch:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
+ 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
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. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
+ description: volume object that needs to be updated.
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/patchDefinitions/volume"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
+ summary: delete an existing volume
+ description: delete an existing volume
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
consumes:
- application/json
- application/xml
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:
+ - 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
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
+ get:
tags:
- CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
+ summary: returns volumes
+ description: returns volumes
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volumes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __VSERVER-ID__
- - name: interface-name
+ - name: volume-id
+ in: query
+ description:
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
+ consumes:
+ - 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: Name given to the interface
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- example: __INTERFACE-NAME__
- - name: vlan-interface
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
in: path
- description: String that identifies the interface
+ description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
- example: __VLAN-INTERFACE__
+ 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. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
consumes:
- application/json
- application/xml
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:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
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/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
consumes:
- application/json
- application/xml
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:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
tags:
- CloudInfrastructure
- summary: returns l3-interface-ipv4-address-list
- description: returns l3-interface-ipv4-address-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __L3-INTERFACE-IPV4-ADDRESS__
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - 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: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: tenant-context
- in: query
- description: This field will store the tenant context.
- required: false
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vserver-name
- in: query
- description: Name of vserver
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vserver-name2
- in: query
- description: Alternative name of vserver
- required: false
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __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:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-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: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
type: string
- - name: 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
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: 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__
put:
tags:
- CloudInfrastructure
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __VLAN-INTERFACE__
- - 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: vpn-key
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
required: true
type: string
example: __PCI-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
- - 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: 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
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
+ - name: pci-id
in: query
- description: Name of vserver
+ description:
required: false
type: string
- - name: vserver-name2
+ - name: vf-vlan-filter
in: query
- description: Alternative name of vserver
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-mac-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
+ - name: vf-vlan-strip
in: query
+ description:
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
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
required: true
type: string
example: __L3-INTERFACE-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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __VSERVER-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
- - name: tenant-name
- in: query
- description: Readable name of tenant
- required: false
- type: string
- - name: tenant-context
+ - name: interface-name
in: query
- description: This field will store the tenant context.
+ description:
required: false
type: string
- - name: vserver-name
+ - name: interface-id
in: query
- description: Name of vserver
+ description:
required: false
type: string
- - name: vserver-name2
+ - name: macaddr
in: query
- description: Alternative name of vserver
+ description:
required: false
type: string
- - name: prov-status
+ - name: network-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
get:
tags:
required: true
type: string
example: __VSERVER-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
- - 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
put:
tags:
- CloudInfrastructure
example: __VSERVER-ID__
- name: body
in: body
- description: vserver object that needs to be created or updated.
+ description: vserver object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vserver"
required: true
type: string
example: __TENANT-ID__
- - name: cloud-type
+ - name: vserver-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: vserver-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
- - name: tenant-name
+ - name: vserver-name2
in: query
- description: Readable name of tenant
+ description:
required: false
type: string
- - name: tenant-context
+ - name: prov-status
in: query
- description: This field will store the tenant context.
+ description:
required: false
type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __TENANT-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
- - 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
put:
tags:
- CloudInfrastructure
example: __TENANT-ID__
- name: body
in: body
- description: tenant object that needs to be created or updated.
+ description: tenant object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/tenant"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: tenant-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: tenant-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
required: true
type: string
example: __HPA-CAPABILITY-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute:
- get:
- tags:
- - CloudInfrastructure
- summary: returns hpa-feature-attribute
- description: returns hpa-feature-attribute
- operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/hpa-feature-attribute"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: cloud-owner
+ - name: hpa-attribute-key
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.
+ description: name of the specific HPA attribute
required: true
type: string
- example: __FLAVOR-ID__
- - name: hpa-capability-id
- in: path
- description: UUID to uniquely identify a HPA capability
- required: true
- type: string
- example: __HPA-CAPABILITY-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
- - name: flavor-name
- in: query
- description: Cloud Region Flavor name
- required: false
- type: string
- - name: hpa-feature
- in: query
- description: Name of the HPACapability
- required: false
- type: string
- - name: hpa-hw-arch
- in: query
- description: Hardware architecture
- required: false
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
+ example: __HPA-ATTRIBUTE-KEY__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
get:
tags:
- CloudInfrastructure
- summary: returns hpa-capability
- description: returns hpa-capability
- operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ summary: returns hpa-feature-attributes
+ description: returns hpa-feature-attributes
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/hpa-capability"
+ $ref: "#/getDefinitions/hpa-feature-attributes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __HPA-CAPABILITY-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
- - name: flavor-name
- in: query
- description: Cloud Region Flavor name
- required: false
- type: string
- - name: hpa-feature
- in: query
- description: Name of the HPACapability
- required: false
- type: string
- - name: hpa-hw-arch
- in: query
- description: Hardware architecture
- required: false
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
type: string
+ example: __HPA-ATTRIBUTE-KEY__
put:
tags:
- CloudInfrastructure
- summary: create or update an existing hpa-capability
+ summary: create or update an existing hpa-feature-attributes
description: |
- Create or update an existing hpa-capability.
+ Create or update an existing hpa-feature-attributes.
#
Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
- name: body
in: body
- description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
+ description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
required: true
schema:
- $ref: "#/definitions/hpa-capability"
+ $ref: "#/definitions/hpa-feature-attributes"
patch:
tags:
- CloudInfrastructure
- summary: update an existing hpa-capability
+ summary: update an existing hpa-feature-attributes
description: |
- Update an existing hpa-capability
+ Update an existing hpa-feature-attributes
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
- For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
- PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
- operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
- name: body
in: body
- description: hpa-capability object that needs to be created or updated.
+ description: hpa-feature-attributes object that needs to be updated.
required: true
schema:
- $ref: "#/patchDefinitions/hpa-capability"
+ $ref: "#/patchDefinitions/hpa-feature-attributes"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing hpa-capability
- description: delete an existing hpa-capability
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ summary: delete an existing hpa-feature-attributes
+ description: delete an existing hpa-feature-attributes
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
- 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}/flavors/flavor/{flavor-id}/hpa-capabilities:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
get:
tags:
- CloudInfrastructure
- summary: returns hpa-capabilities
- description: returns hpa-capabilities
- operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
+ summary: returns hpa-capability
+ description: returns hpa-capability
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/hpa-capabilities"
+ $ref: "#/getDefinitions/hpa-capability"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __FLAVOR-ID__
- - name: cloud-type
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing hpa-capability
+ description: |
+ Create or update an existing hpa-capability.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
+ required: true
+ schema:
+ $ref: "#/definitions/hpa-capability"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing hpa-capability
+ description: |
+ Update an existing hpa-capability
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: hpa-capability object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/hpa-capability"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing hpa-capability
+ description: delete an existing hpa-capability
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns hpa-capabilities
+ description: returns hpa-capabilities
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/hpa-capabilities"
+ "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: hpa-capability-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: hpa-feature
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
- - name: flavor-name
+ - name: architecture
in: query
- description: Cloud Region Flavor name
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
required: true
type: string
example: __FLAVOR-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
- - name: flavor-name
- in: query
- description: Cloud Region Flavor name
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __FLAVOR-ID__
- name: body
in: body
- description: flavor object that needs to be created or updated.
+ description: flavor object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/flavor"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: flavor-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: flavor-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
required: true
type: string
example: __GROUP-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
- - name: group-type
- in: query
- description: Group type - the type of group this instance refers to
- required: false
- type: string
- - name: group-name
- in: query
- description: Group name - name assigned to the group
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/group-assignment"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: group-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: group-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: group-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
required: true
type: string
example: __SNAPSHOT-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
- - name: snapshot-name
- in: query
- description: Snapshot name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
- - name: prev-snapshot-id
- in: query
- description: This field contains the UUID of the previous snapshot (if any).
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __SNAPSHOT-ID__
- name: body
in: body
- description: snapshot object that needs to be created or updated.
+ description: snapshot object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/snapshot"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: snapshot-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: snapshot-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prev-snapshot-id
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
required: true
type: string
example: __METANAME__
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
- type: string
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated.
+ description: metadatum object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/metadatum"
required: true
type: string
example: __IMAGE-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
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
+ - name: metaname
in: query
- description: The version of the application.
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
required: true
type: string
example: __IMAGE-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
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __IMAGE-ID__
- name: body
in: body
- description: image object that needs to be created or updated.
+ description: image object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/image"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: image-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: image-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-vendor
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
required: true
type: string
example: __SWITCH-NAME__
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
- type: string
- - name: vcenter-url
- in: query
- description: URL used to reach the vcenter
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/dvs-switch"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: switch-name
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: vcenter-url
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
required: true
type: string
example: __NETWORK-UUID__
- - name: cloud-type
- in: query
- description: Type of the cloud (e.g., openstack)
- required: false
- type: string
- - name: owner-defined-type
- in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
- required: false
- type: string
- - name: network-name
- in: query
- description: Name of the network.
- required: false
- type: string
- - name: cvlan-tag
- in: query
- description: cvlan-id
- required: false
- type: integer
- format: int64
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/oam-network"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: network-uuid
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: network-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
+ - name: cvlan-tag
+ in: query
+ description:
+ required: false
+ type: integer
+ format: int64
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __AVAILABILITY-ZONE-NAME__
- - 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
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/availability-zone"
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
+ - name: availability-zone-name
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
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
example: __VIP-IPV4-ADDRESS__
- name: body
in: body
- description: vip-ipv4-address-list object that needs to be created or updated.
+ description: vip-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vip-ipv4-address-list"
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
example: __VIP-IPV6-ADDRESS__
- name: body
in: body
- description: vip-ipv6-address-list object that needs to be created or updated.
+ description: vip-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vip-ipv6-address-list"
required: true
type: string
example: __HPA-CAPABILITY-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __HPA-CAPABILITY-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute:
- get:
- tags:
- - CloudInfrastructure
- summary: returns hpa-feature-attribute
- description: returns hpa-feature-attribute
- operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/hpa-feature-attribute"
- "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
+ - name: hpa-attribute-key
in: path
- description: Identifier used by the vendor for the region. Second part of composite key
+ description: name of the specific HPA attribute
required: true
type: string
- example: __CLOUD-REGION-ID__
- - name: hpa-capability-id
- in: path
- description: UUID to uniquely identify a HPA capability
- required: true
- type: string
- example: __HPA-CAPABILITY-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
- - name: hpa-feature
- in: query
- description: Name of the HPACapability
- required: false
- type: string
- - name: hpa-hw-arch
- in: query
- description: Hardware architecture
- required: false
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
+ example: __HPA-ATTRIBUTE-KEY__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
get:
tags:
- CloudInfrastructure
- summary: returns hpa-capability
- description: returns hpa-capability
- operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ summary: returns hpa-feature-attributes
+ description: returns hpa-feature-attributes
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/hpa-capability"
+ $ref: "#/getDefinitions/hpa-feature-attributes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __HPA-CAPABILITY-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
- - name: hpa-feature
- in: query
- description: Name of the HPACapability
- required: false
- type: string
- - name: hpa-hw-arch
- in: query
- description: Hardware architecture
- required: false
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
type: string
+ example: __HPA-ATTRIBUTE-KEY__
put:
tags:
- CloudInfrastructure
- summary: create or update an existing hpa-capability
+ summary: create or update an existing hpa-feature-attributes
description: |
- Create or update an existing hpa-capability.
+ Create or update an existing hpa-feature-attributes.
#
Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
+ - name: body
+ in: body
+ description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
+ required: true
+ schema:
+ $ref: "#/definitions/hpa-feature-attributes"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing hpa-feature-attributes
+ description: |
+ Update an existing hpa-feature-attributes
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
+ - name: body
+ in: body
+ description: hpa-feature-attributes object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/hpa-feature-attributes"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing hpa-feature-attributes
+ description: delete an existing hpa-feature-attributes
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
+ consumes:
+ - 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: hpa-attribute-key
+ in: path
+ description: name of the specific HPA attribute
+ required: true
+ type: string
+ example: __HPA-ATTRIBUTE-KEY__
+ - 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}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns hpa-capability
+ description: returns hpa-capability
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/hpa-capability"
+ "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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing hpa-capability
+ description: |
+ Create or update an existing hpa-capability.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
consumes:
- application/json
- application/xml
example: __HPA-CAPABILITY-ID__
- name: body
in: body
- description: hpa-capability object that needs to be created or updated.
+ description: hpa-capability object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/hpa-capability"
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: cloud-type
+ - name: hpa-capability-id
in: query
- description: Type of the cloud (e.g., openstack)
+ description:
required: false
type: string
- - name: owner-defined-type
+ - name: hpa-feature
in: query
- description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ description:
+ required: false
+ type: string
+ - name: architecture
+ in: query
+ description:
required: false
type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
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
put:
tags:
- CloudInfrastructure
example: __CLOUD-REGION-ID__
- name: body
in: body
- description: cloud-region object that needs to be created or updated.
+ description: cloud-region object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/cloud-region"
$ref: "#/getDefinitions/cloud-regions"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: query
+ description:
+ required: false
+ type: string
+ - name: cloud-region-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: cloud-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
put:
tags:
example: __NM-PROFILE-NAME__
- name: body
in: body
- description: network-profile object that needs to be created or updated.
+ description: network-profile object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/network-profile"
$ref: "#/getDefinitions/network-profiles"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
put:
tags:
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.
- 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
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-pf"
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: prov-status
+ - name: pf-pci-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
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:
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.
- 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
put:
tags:
- CloudInfrastructure
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
put:
tags:
- CloudInfrastructure
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
put:
tags:
- CloudInfrastructure
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: interface-id
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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.
- 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
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - 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
- - 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: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ 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/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
- put:
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
tags:
- CloudInfrastructure
- summary: create or update an existing sriov-vf
- description: |
- Create or update an existing sriov-vf.
- #
- Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - 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. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
- required: true
- schema:
- $ref: "#/definitions/sriov-vf"
- patch:
- tags:
- - CloudInfrastructure
- summary: update an existing sriov-vf
- description: |
- Update an existing sriov-vf
- #
- Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
- The PUT operation will entirely replace an existing object.
- The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
- #
- Other differences between PUT and PATCH are:
- #
- - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
- - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
- - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
- operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: hostname
- in: path
- description: Value from executing hostname on the compute node.
- required: true
- type: string
- example: __HOSTNAME__
- - name: interface-name
- in: path
- description: Name that identifies the physical interface
- required: true
- type: string
- example: __INTERFACE-NAME__
- - name: interface-name
- in: path
- description: Name given to the interface
- required: true
- type: string
- example: __INTERFACE-NAME__
- - name: pci-id
- in: path
- description: PCI ID used to identify the sriov-vf
- required: true
- type: string
- example: __PCI-ID__
- - name: body
- in: body
- description: sriov-vf object that needs to be created or updated.
- required: true
- schema:
- $ref: "#/patchDefinitions/sriov-vf"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing sriov-vf
- description: delete an existing sriov-vf
- operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
consumes:
- application/json
- application/xml
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
+ - name: pci-id
in: query
- description: alternative pserver name
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - name: inv-status
+ - name: interface-name
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
required: false
type: string
- - name: pserver-id
+ - name: interface-id
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: macaddr
in: query
- description: alternative pserver name
+ description:
required: false
type: string
- - name: prov-status
+ - name: network-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/p-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.
- required: false
- type: string
- - name: pserver-id
+ - name: interface-name
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: prov-status
in: query
- description: alternative pserver name
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
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.
- 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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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: vpn-key
- in: query
- description: This indicates the customers VPN ID associated with this vlan
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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.
- 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
put:
tags:
- CloudInfrastructure
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
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
+ - name: pci-id
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: vf-vlan-filter
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-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
+ - name: interface-name
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: interface-id
in: query
- description: alternative pserver name
+ description:
required: false
type: string
- - name: interface-id
+ - name: macaddr
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: network-name
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
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
put:
tags:
- CloudInfrastructure
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/lag-interface"
required: true
type: string
example: __HOSTNAME__
- - name: inv-status
+ - name: interface-name
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
required: false
type: string
- - name: pserver-id
+ - name: interface-id
in: query
- description: ID of Pserver
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: pserver-name2
+ - name: interface-role
in: query
- description: alternative pserver name
+ description:
required: false
type: string
/cloud-infrastructure/pservers/pserver/{hostname}:
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:
- CloudInfrastructure
example: __HOSTNAME__
- name: body
in: body
- description: pserver object that needs to be created or updated.
+ description: pserver object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/pserver"
$ref: "#/getDefinitions/pservers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: query
+ description:
+ required: false
+ type: string
+ - name: inv-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __VDC-ID__
- - name: vdc-name
- in: query
- description: Name of the virtual data center
- required: false
- type: string
put:
tags:
- CloudInfrastructure
example: __VDC-ID__
- name: body
in: body
- description: virtual-data-center object that needs to be created or updated.
+ description: virtual-data-center object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/virtual-data-center"
$ref: "#/getDefinitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vdc-name
+ in: query
+ description:
+ required: false
+ type: string
/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
put:
tags:
example: __OPERATIONAL-ENVIRONMENT-ID__
- name: body
in: body
- description: operational-environment object that needs to be created or updated.
+ description: operational-environment object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/operational-environment"
$ref: "#/getDefinitions/operational-environments"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: query
+ description:
+ required: false
+ type: string
/business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __METANAME__
- - 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
put:
tags:
- Business
example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated.
+ description: metadatum object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/metadatum"
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.
- 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
+ - name: metaname
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/business/connectors/connector/{resource-instance-id}:
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.
- 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
put:
tags:
- Business
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/connector"
$ref: "#/getDefinitions/connectors"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __METANAME__
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
+ put:
+ tags:
+ - Business
+ 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: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ consumes:
+ - 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: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
type: string
- - name: environment-context
- in: query
- description: This field will store the environment context assigned to the service-instance.
- required: false
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
type: string
- - name: workload-context
- in: query
- description: This field will store the workload context assigned to the service-instance.
- required: false
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/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
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
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
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
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
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ consumes:
+ - 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-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
type: string
- - name: orchestration-status
+ 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: Orchestration status of this service.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- put:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
+ get:
tags:
- Business
- 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: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
- consumes:
- - application/json
- - application/xml
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
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:
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. [Valid relationship examples shown here](apidocs/relations/v13/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
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
- consumes:
- - 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: 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}/metadata:
- get:
- tags:
- - Business
- summary: returns metadata
- description: returns metadata
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
- 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: 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.
- 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.
+ description:
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}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
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
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/tunnel-xconnect"
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
+ - name: id
in: query
- description: role in the network that this resource will be providing.
+ description:
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:
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
example: __ID__
- name: body
in: body
- description: allotted-resource object that needs to be created or updated.
+ description: allotted-resource object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/allotted-resource"
required: true
type: string
example: __SERVICE-INSTANCE-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
+ - name: id
in: query
- description: This field will store the workload context assigned to the service-instance.
+ description:
required: false
type: string
- name: model-invariant-id
in: query
- description: the ASDC model id for this resource or service model.
+ description:
required: false
type: string
- name: model-version-id
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- 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
+ - name: type
in: query
- description: An identifier that customers assign to the location where this service is being used.
+ description:
required: false
type: string
- - name: orchestration-status
+ - name: role
in: query
- description: Orchestration status of this service.
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
required: true
type: string
example: __SERVICE-INSTANCE-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
put:
tags:
- Business
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/service-instance"
required: true
type: string
example: __SERVICE-TYPE__
- - name: subscriber-name
+ - name: service-instance-id
in: query
- description: Subscriber name, an alternate way to retrieve a customer.
+ description:
required: false
type: string
- - name: subscriber-type
+ - name: service-instance-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description:
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: orchestration-status
in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
required: true
type: string
example: __SERVICE-TYPE__
- - 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
put:
tags:
- Business
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/service-subscription"
required: true
type: string
example: __GLOBAL-CUSTOMER-ID__
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
- type: string
- - name: subscriber-type
+ - name: service-type
in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description:
required: false
type: string
/business/customers/customer/{global-customer-id}/relationship-list/relationship:
required: true
type: string
example: __GLOBAL-CUSTOMER-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
put:
tags:
- Business
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/customer"
$ref: "#/getDefinitions/customers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: subscriber-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description:
+ required: false
+ type: string
/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/line-of-business"
$ref: "#/getDefinitions/lines-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: query
+ description:
+ required: false
+ type: string
/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/owning-entity"
$ref: "#/getDefinitions/owning-entities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: query
+ description:
+ required: false
+ type: string
/business/platforms/platform/{platform-name}/relationship-list/relationship:
put:
tags:
example: __PLATFORM-NAME__
- name: body
in: body
- description: platform object that needs to be created or updated.
+ description: platform object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/platform"
$ref: "#/getDefinitions/platforms"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: query
+ description:
+ required: false
+ type: string
/business/projects/project/{project-name}/relationship-list/relationship:
put:
tags:
example: __PROJECT-NAME__
- name: body
in: body
- description: project object that needs to be created or updated.
+ description: project object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/project"
$ref: "#/getDefinitions/projects"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __VNF-IMAGE-UUID__
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/vnf-image"
$ref: "#/getDefinitions/vnf-images"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description:
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __SERVICE-ID__
- - name: service-description
- in: query
- description: Description of the service
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
example: __SERVICE-ID__
- name: body
in: body
- description: service object that needs to be created or updated.
+ description: service object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/service"
$ref: "#/getDefinitions/services"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-description
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/service-capability"
$ref: "#/getDefinitions/service-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ 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/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
put:
tags:
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.
- 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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/element-choice-set"
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.
- 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
- - name: distribution-status
+ - name: element-choice-set-uuid
in: query
- description: Distribution Status
+ description:
required: false
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/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
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.
- 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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/constrained-element-set"
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
- - name: distribution-status
+ - name: constrained-element-set-uuid
in: query
- description: Distribution Status
+ description:
required: false
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}:
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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/model-constraint"
required: true
type: string
example: __MODEL-ELEMENT-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
- - name: distribution-status
+ - name: model-constraint-uuid
in: query
- description: Distribution Status
+ description:
required: false
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}/relationship-list/relationship:
required: true
type: string
example: __MODEL-ELEMENT-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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/model-element"
required: true
type: string
example: __MODEL-VERSION-ID__
- - 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
- - name: distribution-status
+ - name: model-element-uuid
in: query
- description: Distribution Status
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
required: true
type: string
example: __METANAME__
- - 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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated.
+ description: metadatum object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/metadatum"
required: true
type: string
example: __MODEL-VERSION-ID__
- - 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
- - name: distribution-status
+ - name: metaname
in: query
- description: Distribution Status
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
required: true
type: string
example: __MODEL-VERSION-ID__
- - 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
- - name: distribution-status
- in: query
- description: Distribution Status
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/model-ver"
required: true
type: string
example: __MODEL-INVARIANT-ID__
- - name: model-type
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: distribution-status
in: query
- description: Type of the model, e.g., service, resource, widget, etc.
+ description:
required: false
type: string
/service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
required: true
type: string
example: __MODEL-INVARIANT-ID__
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/model"
$ref: "#/getDefinitions/models"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-type
+ in: query
+ description:
+ required: false
+ type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __RELATED-LOOKUP-UUID__
- - name: named-query-name
- in: query
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/related-lookup"
required: true
type: string
example: __NAMED-QUERY-ELEMENT-UUID__
- - name: named-query-name
+ - name: related-lookup-uuid
in: query
+ description:
required: false
type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
required: true
type: string
example: __PROPERTY-CONSTRAINT-UUID__
- - name: named-query-name
- in: query
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/property-constraint"
required: true
type: string
example: __NAMED-QUERY-ELEMENT-UUID__
- - name: named-query-name
+ - name: property-constraint-uuid
in: query
+ description:
required: false
type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
required: true
type: string
example: __NAMED-QUERY-ELEMENT-UUID__
- - name: named-query-name
- in: query
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/named-query-element"
required: true
type: string
example: __NAMED-QUERY-UUID__
- - name: named-query-name
+ - name: named-query-element-uuid
in: query
+ description:
required: false
type: string
/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
required: true
type: string
example: __NAMED-QUERY-UUID__
- - name: named-query-name
- in: query
- required: false
- type: string
put:
tags:
- ServiceDesignAndCreation
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/named-query"
$ref: "#/getDefinitions/named-queries"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: query
+ description:
+ required: false
+ type: string
+ - name: named-query-name
+ in: query
+ description:
+ required: false
+ type: string
/network/logical-links/logical-link/{link-name}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __LINK-NAME__
- - 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: prov-status
- in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
- required: false
- type: string
- - name: link-id
- in: query
- description: UUID of the logical-link, SDNC generates this.
- required: false
- type: string
- - name: circuit-id
- in: query
- description: Circuit id
- required: false
- type: string
- - name: purpose
- in: query
- description: Reason for this entity, role it is playing
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/logical-link"
$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:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
- consumes:
- - 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
+ - name: link-name
+ in: query
+ description:
+ required: false
type: string
- example: __SITE-PAIR-SET-ID__
- - name: routing-instance-id
- in: path
- description: Unique id of routing instance
- required: true
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
type: string
- example: __ROUTING-INSTANCE-ID__
- - name: site-pair-id
- in: path
- description: unique identifier of probe
- required: true
+ - name: model-version-id
+ in: query
+ description:
+ required: false
type: string
- example: __SITE-PAIR-ID__
- - name: cos
- in: path
- description: unique identifier of probe
- required: true
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
type: string
- example: __COS__
- - name: body
- in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
- consumes:
- - 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
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
type: string
- example: __SITE-PAIR-SET-ID__
- - name: routing-instance-id
- in: path
- description: Unique id of routing instance
- required: true
+ - name: prov-status
+ in: query
+ description:
+ required: false
type: string
- example: __ROUTING-INSTANCE-ID__
- - name: site-pair-id
- in: path
- description: unique identifier of probe
- required: true
+ - name: link-id
+ in: query
+ description:
+ required: false
type: string
- example: __SITE-PAIR-ID__
- - name: cos
- in: path
- description: unique identifier of probe
- required: true
+ - name: circuit-id
+ in: query
+ description:
+ required: false
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:
+ - name: purpose
+ in: query
+ description:
+ required: false
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
+ put:
tags:
- Network
- summary: returns class-of-service
- description: returns class-of-service
- operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/class-of-service"
+ "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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ consumes:
+ - 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__
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
+ get:
+ tags:
+ - Network
+ summary: returns class-of-service
+ description: returns class-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/class-of-service"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/class-of-service"
required: true
type: string
example: __SITE-PAIR-ID__
+ - name: cos
+ in: query
+ description:
+ required: false
+ type: string
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/site-pair"
required: true
type: string
example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: query
+ description:
+ required: false
+ type: string
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/routing-instance"
required: true
type: string
example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: query
+ description:
+ required: false
+ type: string
/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/site-pair-set"
$ref: "#/getDefinitions/site-pair-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
put:
tags:
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
example: __ROUTE-TARGET-ROLE__
- name: body
in: body
- description: route-target object that needs to be created or updated.
+ description: route-target object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/route-target"
required: true
type: string
example: __VPN-ID__
- - 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}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __VPN-ID__
- - 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
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/vpn-binding"
$ref: "#/getDefinitions/vpn-bindings"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vpn-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description:
+ required: false
+ type: string
/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
put:
tags:
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.
- 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-pf"
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.
- required: false
- type: string
- - name: prov-status
+ - name: pf-pci-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
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:
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.
- 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
put:
tags:
- Network
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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.
- 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
put:
tags:
- Network
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
put:
tags:
- Network
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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.
- 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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.
- 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: 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:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - name: prov-status
+ - name: pci-id
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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.
- 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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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.
- 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - name: prov-status
+ - name: interface-name
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: prov-status
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: macaddr
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
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.
- 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/p-interface"
required: true
type: string
example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
- name: prov-status
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
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.
- 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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.
- 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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.
- 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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.
- 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
put:
tags:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
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.
- required: false
- type: string
- - name: interface-id
+ - name: pci-id
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: vf-vlan-filter
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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:
- Network
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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.
- required: false
+ 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - 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-id
- in: query
- description: ID of interface
- required: false
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate 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: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ 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/v13/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
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
type: string
- put:
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
- consumes:
- - 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. [Valid relationship examples shown here](apidocs/relations/v13/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
- summary: delete an existing l3-interface-ipv6-address-list
- description: delete an existing l3-interface-ipv6-address-list
- operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
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.
- 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - name: prov-status
+ - name: interface-name
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- name: interface-id
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: macaddr
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-name
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
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.
- 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/lag-interface"
required: true
type: string
example: __EQUIPMENT-NAME__
- - name: prov-status
+ - name: interface-name
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description:
required: false
type: string
/network/vpls-pes/vpls-pe/{equipment-name}:
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.
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/vpls-pe"
$ref: "#/getDefinitions/vpls-pes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/multicast-configuration"
$ref: "#/getDefinitions/multicast-configurations"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
put:
tags:
type: integer
format: int64
example: __CVLAN-TAG__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/cvlan-tag-entry"
required: true
type: string
example: __INTERFACE-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
+ - name: cvlan-tag
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
- type: string
+ type: integer
+ format: int64
/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __INTERFACE-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
put:
tags:
- Network
example: __INTERFACE-ID__
- name: body
in: body
- description: port-group object that needs to be created or updated.
+ description: port-group object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/port-group"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
+ - name: interface-id
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description:
required: false
type: string
- - name: regional-resource-zone
+ - name: port-group-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: switch-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- name: heat-stack-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
+ description:
required: false
type: string
/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
required: true
type: string
example: __RESOURCE-UUID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
put:
tags:
- Network
example: __RESOURCE-UUID__
- name: body
in: body
- description: license object that needs to be created or updated.
+ description: license object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/license"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
+ - name: group-uuid
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: vpe-id
+ - name: resource-uuid
in: query
- description: Unique ID of VPE connected to this VCE.
+ description:
required: false
type: string
/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
required: true
type: string
example: __RESOURCE-UUID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
put:
tags:
- Network
example: __RESOURCE-UUID__
- name: body
in: body
- description: entitlement object that needs to be created or updated.
+ description: entitlement object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/entitlement"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
+ - name: group-uuid
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: vpe-id
+ - name: resource-uuid
in: query
- description: Unique ID of VPE connected to this VCE.
+ description:
required: false
type: string
/network/vces/vce/{vnf-id}/relationship-list/relationship:
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
- in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
- type: string
put:
tags:
- Network
example: __VNF-ID__
- name: body
in: body
- description: vce object that needs to be created or updated.
+ description: vce object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vce"
$ref: "#/getDefinitions/vces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description:
+ required: false
+ type: string
/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
put:
tags:
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
- required: false
- type: string
- - name: nfc-function
- in: query
- description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
- required: false
- type: string
- - name: prov-status
- in: query
- description: prov status of this vnfc
- required: false
- type: string
- - name: ipaddress-v4-oam-vip
- in: query
- description: Oam V4 vip address of this vnfc
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: group-notation
- in: query
- description: Group notation of VNFC
- required: false
- type: string
- - 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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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
- required: false
- type: string
- - name: nfc-function
- in: query
- description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
- required: false
- type: string
- - name: prov-status
- in: query
- description: prov status of this vnfc
- required: false
- type: string
- - name: ipaddress-v4-oam-vip
- in: query
- description: Oam V4 vip address of this vnfc
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: group-notation
- in: query
- description: Group notation of VNFC
- required: false
- type: string
- - 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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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
- required: false
- type: string
- - name: nfc-function
- in: query
- description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
- required: false
- type: string
- - name: prov-status
- in: query
- description: prov status of this vnfc
- required: false
- type: string
- - name: ipaddress-v4-oam-vip
- in: query
- description: Oam V4 vip address of this vnfc
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: group-notation
- in: query
- description: Group notation of VNFC
- required: false
- type: string
- - 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
put:
tags:
- Network
example: __VNFC-NAME__
- name: body
in: body
- description: vnfc object that needs to be created or updated.
+ description: vnfc object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vnfc"
$ref: "#/getDefinitions/vnfcs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nfc-naming-code
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __HOST-ROUTE-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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: subnet-name
- in: query
- description: Name associated with the subnet.
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/host-route"
required: true
type: string
example: __SUBNET-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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: subnet-name
+ - name: host-route-id
in: query
- description: Name associated with the subnet.
+ description:
required: false
type: string
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
required: true
type: string
example: __SUBNET-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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: subnet-name
- in: query
- description: Name associated with the subnet.
- required: false
- type: string
put:
tags:
- Network
example: __SUBNET-ID__
- name: body
in: body
- description: subnet object that needs to be created or updated.
+ description: subnet object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/subnet"
required: true
type: string
example: __NETWORK-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
+ - name: subnet-id
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- - name: widget-model-version
+ - name: subnet-name
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
type: integer
format: int64
example: __VLAN-ID-INNER__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/ctag-assignment"
required: true
type: string
example: __NETWORK-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
+ - name: vlan-id-inner
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
- type: string
+ type: integer
+ format: int64
/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __SEGMENTATION-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/segmentation-assignment"
required: true
type: string
example: __NETWORK-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
+ - name: segmentation-id
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
/network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
required: true
type: string
example: __NETWORK-ID__
- - name: network-name
- in: query
- description: Name of the network, governed by some naming convention..
- required: false
- type: string
- - name: network-role
- in: query
- description: Role the network plans - who defines these values?
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: contrail-network-fqdn
- in: query
- description: Contrail FQDN for the network
- required: false
- type: string
- - name: 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-network"
$ref: "#/getDefinitions/l3-networks"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __NETWORK-POLICY-ID__
- - name: network-policy-fqdn
- in: query
- description: Contrail FQDN for the policy
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/network-policy"
$ref: "#/getDefinitions/network-policies"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-policy-fqdn
+ in: query
+ description:
+ required: false
+ type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __L3-INTERFACE-IPV4-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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __VLAN-INTERFACE__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
- - name: interface-id
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
required: true
type: string
example: __PCI-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
put:
tags:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: pci-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-mac-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
+ - name: vf-vlan-strip
in: query
+ description:
required: false
type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
- - name: interface-id
- in: query
- description: ID of interface
- required: false
- type: string
- - name: macaddr
- in: query
- description: MAC address for the interface
- required: false
- type: string
- - name: network-name
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
required: true
type: string
example: __L3-INTERFACE-IPV4-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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
+ - name: interface-name
in: query
- description: Generic description of the type of NF
+ description:
required: false
type: string
- - name: nf-function
+ - name: interface-id
in: query
- description: English description of Network function that the specific VNF deployment is providing
+ description:
required: false
type: string
- - name: nf-role
+ - name: macaddr
in: query
- description: role in the network that this model will be providing
+ description:
required: false
type: string
- - name: nf-naming-code
+ - name: network-name
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
required: true
type: string
example: __L3-INTERFACE-IPV4-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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __VLAN-INTERFACE__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
required: true
type: string
example: __PCI-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
put:
tags:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: pci-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-mac-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
+ - name: vf-vlan-strip
in: query
+ description:
required: false
type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
required: true
type: string
example: __L3-INTERFACE-IPV4-ADDRESS__
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
type: string
- - name: 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- - Network
- summary: create or update an existing l3-interface-ipv4-address-list
- description: |
- Create or update an existing l3-interface-ipv4-address-list.
- #
- Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
- consumes:
- - 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
+ 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
+ - name: interface-name
in: query
- description: role in the network that this model will be providing
+ description:
required: false
type: string
- - name: nf-naming-code
+ - name: interface-id
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
- - name: interface-id
+ - name: macaddr
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: network-name
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
required: true
type: string
example: __INTERFACE-NAME__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/lag-interface"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
+ - name: interface-name
in: query
- description: English description of Network function that the specific VNF deployment is providing
+ description:
required: false
type: string
- - name: nf-role
+ - name: interface-id
in: query
- description: role in the network that this model will be providing
+ description:
required: false
type: string
- - name: nf-naming-code
+ - name: interface-role
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
required: true
type: string
example: __VF-MODULE-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
- - name: vf-module-name
- in: query
- description: Name of vf-module
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance.
- required: false
- type: string
- - name: 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: contrail-service-instance-fqdn
- in: query
- description: the Contrail unique ID for a service-instance
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/vf-module"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
+ - name: vf-module-id
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-module-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- name: heat-stack-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- name: model-invariant-id
in: query
- description: the ASDC model id for this resource or service model.
+ description:
required: false
type: string
- name: model-version-id
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
- name: widget-model-id
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description:
required: false
type: string
- name: widget-model-version
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description:
required: false
type: string
- - name: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
+ - name: contrail-service-instance-fqdn
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
required: true
type: string
example: __RESOURCE-UUID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
put:
tags:
- Network
example: __RESOURCE-UUID__
- name: body
in: body
- description: license object that needs to be created or updated.
+ description: license object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/license"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
+ - name: group-uuid
in: query
- description: role in the network that this model will be providing
+ description:
required: false
type: string
- - name: nf-naming-code
+ - name: resource-uuid
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
required: true
type: string
example: __RESOURCE-UUID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
put:
tags:
- Network
example: __RESOURCE-UUID__
- name: body
in: body
- description: entitlement object that needs to be created or updated.
+ description: entitlement object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/entitlement"
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
+ - name: group-uuid
in: query
- description: role in the network that this model will be providing
+ description:
required: false
type: string
- - name: nf-naming-code
+ - name: resource-uuid
in: query
- description: string assigned to this model used for naming purposes
+ description:
required: false
type: string
/network/generic-vnfs/generic-vnf/{vnf-id}:
required: true
type: string
example: __VNF-ID__
- - 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: service-id
- in: query
- description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: in-maint
- in: query
- required: false
- type: boolean
- - name: is-closed-loop-disabled
- in: query
- required: false
- type: boolean
- - name: 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: nf-type
- in: query
- description: Generic description of the type of NF
- required: false
- type: string
- - name: nf-function
- in: query
- description: English description of Network function that the specific VNF deployment is providing
- required: false
- type: string
- - name: nf-role
- in: query
- description: role in the network that this model will be providing
- required: false
- type: string
- - name: nf-naming-code
- in: query
- description: string assigned to this model used for naming purposes
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/generic-vnf"
$ref: "#/getDefinitions/generic-vnfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ description:
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description:
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description:
+ required: false
+ type: string
/network/lag-links/lag-link/{link-name}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/lag-link"
$ref: "#/getDefinitions/lag-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: query
+ description:
+ required: false
+ type: string
/network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __L3-INTERFACE-IPV4-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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __VLAN-INTERFACE__
- - 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
put:
tags:
- Network
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
required: true
type: string
example: __PCI-ID__
- - name: body
- in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
- consumes:
- - 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__
- /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
- get:
- tags:
- - Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/sriov-vf"
- "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: 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
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - 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: macaddr
- in: query
- description: MAC address for the interface
- required: false
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: network-name
- in: query
- description: Name of the network
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
- - name: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
+ example: __PCI-ID__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "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: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
+ example: __PCI-ID__
put:
tags:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
+ - name: pci-id
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: vf-vlan-filter
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
required: true
type: string
example: __L3-INTERFACE-IPV4-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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
required: true
type: string
example: __INTERFACE-NAME__
- - 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __VNF-ID2__
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
+ - name: interface-name
in: query
- description: Alternate name of VNF.
+ description:
required: false
type: string
- - name: vnf-type
+ - name: interface-id
in: query
- description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ description:
required: false
type: string
- - name: prov-status
+ - name: macaddr
in: query
- description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ description:
required: false
type: string
- - name: heat-stack-id
+ - name: network-name
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description:
required: false
type: string
/network/newvces/newvce/{vnf-id2}:
required: true
type: string
example: __VNF-ID2__
- - 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
put:
tags:
- Network
example: __VNF-ID2__
- name: body
in: body
- description: newvce object that needs to be created or updated.
+ description: newvce object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/newvce"
$ref: "#/getDefinitions/newvces"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description:
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description:
+ required: false
+ type: string
/network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
put:
tags:
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.
- 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-pf"
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: prov-status
+ - name: pf-pci-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
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:
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.
- 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
put:
tags:
- Network
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
put:
tags:
- Network
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
put:
tags:
- Network
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: interface-id
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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.
- 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: 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:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
required: true
type: string
example: __INTERFACE-NAME__
- - name: inv-status
+ - name: pci-id
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
required: false
type: string
- - name: prov-status
+ - name: vf-vlan-filter
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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: 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - name: inv-status
+ - name: interface-name
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
required: false
type: string
- - name: prov-status
+ - name: interface-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description:
+ required: false
+ type: string
+ - name: network-name
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
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: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/p-interface"
required: true
type: string
example: __PNF-NAME__
- - name: inv-status
+ - name: interface-name
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
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.
- 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
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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
example: __VLAN-INTERFACE__
- name: body
in: body
- description: vlan object that needs to be created or updated.
+ description: vlan object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/vlan"
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: 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
+ - name: vlan-interface
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vlan-id-inner
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: integer
+ format: int64
+ - name: vpn-key
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
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:
- - Network
- summary: returns sriov-vf
- description: returns sriov-vf
- operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/sriov-vf"
- "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: 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
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "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: vf-vlan-filter
- in: query
- description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
- required: false
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
type: string
- - name: vf-mac-filter
- in: query
- description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
- required: false
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
type: string
- - name: vf-vlan-strip
- in: query
- description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
- required: false
- type: boolean
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface
- required: false
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
type: string
+ example: __PCI-ID__
put:
tags:
- Network
example: __PCI-ID__
- name: body
in: body
- description: sriov-vf object that needs to be created or updated.
+ description: sriov-vf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/sriov-vf"
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: interface-id
+ - name: pci-id
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: vf-vlan-filter
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
required: false
type: string
- - name: interface-id
+ - name: vf-mac-filter
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: macaddr
+ - name: vf-vlan-strip
in: query
- description: MAC address for the interface
+ description:
required: false
- type: string
- - name: network-name
+ type: boolean
+ - name: neutron-network-id
in: query
- description: Name of the network
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
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.
- 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:
- Network
example: __L3-INTERFACE-IPV4-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ description: l3-interface-ipv4-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
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: 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
example: __L3-INTERFACE-IPV6-ADDRESS__
- name: body
in: body
- description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ description: l3-interface-ipv6-address-list object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
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: 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/l-interface"
required: true
type: string
example: __INTERFACE-NAME__
- - name: inv-status
+ - name: interface-name
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
required: false
type: string
- name: interface-id
in: query
- description: ID of interface
+ description:
required: false
type: string
- - name: interface-role
+ - name: macaddr
in: query
- description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ description:
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
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: 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:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/lag-interface"
required: true
type: string
example: __PNF-NAME__
- - name: inv-status
+ - name: interface-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: interface-id
in: query
- description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ description:
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description:
required: false
type: string
/network/pnfs/pnf/{pnf-name}:
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.
- required: false
- type: string
put:
tags:
- Network
example: __PNF-NAME__
- name: body
in: body
- description: pnf object that needs to be created or updated.
+ description: pnf object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/pnf"
$ref: "#/getDefinitions/pnfs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: inv-status
+ in: query
+ description:
+ required: false
+ type: string
/network/physical-links/physical-link/{link-name}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __LINK-NAME__
- - name: circuit-id
- in: query
- description: Circuit it
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/physical-link"
$ref: "#/getDefinitions/physical-links"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: query
+ description:
+ required: false
+ type: string
+ - name: circuit-id
+ in: query
+ description:
+ required: false
+ type: string
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
put:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/vig-server"
required: true
type: string
example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: query
+ description:
+ required: false
+ type: string
/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
get:
tags:
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/ipsec-configuration"
$ref: "#/getDefinitions/ipsec-configurations"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: query
+ description:
+ required: false
+ type: string
/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __ROUTE-TABLE-REFERENCE-ID__
- - name: route-table-reference-fqdn
- in: query
- description: FQDN entry in the route table.
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/route-table-reference"
$ref: "#/getDefinitions/route-table-references"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: route-table-reference-fqdn
+ in: query
+ description:
+ required: false
+ type: string
/network/instance-groups/instance-group/{id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __ID__
- - name: description
- in: query
- description: Descriptive text to help identify the usage of this instance-group
- required: false
- type: string
- - name: type
- in: query
- description: Only valid value today is lower case ha for high availability
- required: false
- type: string
- - name: sub-type
- in: query
- description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
- required: false
- type: string
put:
tags:
- Network
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 updated.
required: true
schema:
$ref: "#/patchDefinitions/instance-group"
$ref: "#/getDefinitions/instance-groups"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: description
+ in: query
+ description:
+ required: false
+ type: string
+ - name: type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: sub-type
+ in: query
+ description:
+ required: false
+ type: string
/network/zones/zone/{zone-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __ZONE-ID__
- - name: design-type
- in: query
- description: Design of zone [Medium/Large…]
- required: false
- type: string
- - name: zone-context
- in: query
- description: Context of zone [production/test]
- required: false
- type: string
put:
tags:
- Network
example: __ZONE-ID__
- name: body
in: body
- description: zone object that needs to be created or updated.
+ description: zone object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/zone"
$ref: "#/getDefinitions/zones"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: design-type
+ in: query
+ description:
+ required: false
+ type: string
+ - name: zone-context
+ in: query
+ description:
+ required: false
+ type: string
/network/configurations/configuration/{configuration-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __METANAME__
- - 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
put:
tags:
- Network
example: __METANAME__
- name: body
in: body
- description: metadatum object that needs to be created or updated.
+ description: metadatum object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/metadatum"
required: true
type: string
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
+ - name: metaname
in: query
- description: the ASDC model version for this resource or service model.
+ description:
required: false
type: string
/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
required: true
type: string
example: __FORWARDER-EVC-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
put:
tags:
- Network
example: __FORWARDER-EVC-ID__
- name: body
in: body
- description: forwarder-evc object that needs to be created or updated.
+ description: forwarder-evc object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/forwarder-evc"
required: true
type: string
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}/evcs/evc/{evc-id}/relationship-list/relationship:
put:
tags:
required: true
type: string
example: __EVC-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
put:
tags:
- Network
example: __EVC-ID__
- name: body
in: body
- description: evc object that needs to be created or updated.
+ description: evc object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/evc"
required: true
type: string
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:
required: true
type: string
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
put:
tags:
- Network
example: __CONFIGURATION-ID__
- name: body
in: body
- description: configuration object that needs to be created or updated.
+ description: configuration object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/configuration"
$ref: "#/getDefinitions/configurations"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description:
+ required: false
+ type: string
/network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
put:
tags:
type: integer
format: int32
example: __SEQUENCE__
- - name: forwarding-path-name
- in: query
- description: Name of the FP
- required: false
- type: string
put:
tags:
- Network
example: __SEQUENCE__
- name: body
in: body
- description: forwarder object that needs to be created or updated.
+ description: forwarder object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/forwarder"
required: true
type: string
example: __FORWARDING-PATH-ID__
- - name: forwarding-path-name
+ - name: sequence
in: query
- description: Name of the FP
+ description:
required: false
- type: string
+ type: integer
+ format: int32
/network/forwarding-paths/forwarding-path/{forwarding-path-id}:
get:
tags:
required: true
type: string
example: __FORWARDING-PATH-ID__
- - name: forwarding-path-name
- in: query
- description: Name of the FP
- required: false
- type: string
put:
tags:
- Network
example: __FORWARDING-PATH-ID__
- name: body
in: body
- description: forwarding-path object that needs to be created or updated.
+ description: forwarding-path object that needs to be updated.
required: true
schema:
$ref: "#/patchDefinitions/forwarding-path"
$ref: "#/getDefinitions/forwarding-paths"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: query
+ description:
+ required: false
+ type: string
+ - name: forwarding-path-name
+ in: query
+ description:
+ required: false
+ type: string
definitions:
- aai-internal:
- properties:
- property-name:
- type: string
- property-value:
- type: string
action:
properties:
action-type:
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)
- - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, 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
+ - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - TO model-ver( allotted-resource IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
required:
- id
properties:
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
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce Uses availability-zone, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
+ -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+
required:
- availability-zone-name
- hypervisor-type
class-of-service:
description: |
###### Related Nodes
- - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
required:
- cos
properties:
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 hpa-capability( hpa-capability 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,HPA-CAPABILITY,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
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
+
+ -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
+ -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+
required:
- cloud-owner
- cloud-region-id
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
cloud-extra-info:
type: string
description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
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
+ - TO l3-network( complex Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
+ - FROM zone( zone LocatedIn complex, MANY2ONE)
+
+ -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
+ -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+
required:
- physical-location-id
- physical-location-type
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)
- - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, 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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
- - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
+ - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
+ - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
+ - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
+
+ -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
+ -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
+ -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
required:
- configuration-id
- configuration-type
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
+ - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
+ - FROM service-instance( service-instance Uses connector, MANY2MANY)
+
+ -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
required:
- resource-instance-id
properties:
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
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
+
+ -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
required:
- constrained-element-set-uuid
- constraint-type
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)
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+ - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
required:
- vlan-id-inner
properties:
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)
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
required:
- target-pe
- availability-zone-name
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
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
required:
- global-customer-id
- subscriber-name
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)
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
required:
- switch-name
- vcenter-url
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
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
+
+ -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
required:
- element-choice-set-uuid
- element-choice-set-name
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)
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
required:
- group-uuid
- resource-uuid
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
required:
- ems-id
properties:
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)
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
required:
- esr-system-info-id
- user-name
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
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
required:
- thirdparty-sdnc-id
properties:
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
required:
- vnfm-id
properties:
description: |
evc object is an optional child object of the Configuration object.
###### Related Nodes
- - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
required:
- evc-id
properties:
description: |
Openstack flavor.
###### Related Nodes
- - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
+
required:
- flavor-id
- flavor-name
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
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDER is DELETED also
required:
- sequence
properties:
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)
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
required:
- forwarder-evc-id
properties:
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
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
+
+ -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
+ -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
required:
- forwarding-path-id
- forwarding-path-name
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)
- - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
+ - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform Uses generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
+ -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
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:
description: number of network in vnf.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
required:
- group-id
- group-type
host-route:
description: |
###### Related Nodes
- - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
required:
- host-route-id
- route-prefix
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)
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
required:
- hpa-capability-id
- hpa-feature
hpa-version:
type: string
description: HPA schema version
- hpa-hw-arch:
+ architecture:
type: string
description: Hardware architecture
resource-version:
type: array
items:
$ref: "#/definitions/relationship"
- hpa-feature-attribute:
+ hpa-feature-attributes:
type: array
items:
- $ref: "#/definitions/hpa-feature-attribute"
- hpa-feature-attribute:
+ $ref: "#/definitions/hpa-feature-attributes"
+ hpa-feature-attributes:
description: |
HPA Capability Feature attributes
+ ###### Related Nodes
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
+ required:
+ - hpa-attribute-key
properties:
- hpa-attr-key:
+ hpa-attribute-key:
type: string
description: name of the specific HPA attribute
- hpa-attr-value:
+ hpa-attribute-value:
type: string
description: JSON string specifying the value, unit and type of the specific HPA attribute
resource-version:
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
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
+ - FROM vserver( vserver Uses image, MANY2ONE)
+
+ -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
+ -IMAGE cannot be deleted if related to VSERVER
+
required:
- image-id
- image-name
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)
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
+
required:
- - instance-group-role
- - model-invariant-id
- - model-version-id
- id
- description
- type
network:
type: object
$ref: "#/definitions/network"
- aai-internal:
- type: object
- $ref: "#/definitions/aai-internal"
nodes:
- type: array
- items:
- $ref: "#/definitions/aai-internal"
+ type: object
+ $ref: "#/definitions/nodes"
inventory-item:
properties:
inventory-item-type:
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
+ - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
required:
- ipsec-configuration-id
properties:
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 logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
- - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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,LOGICAL-LINK,SRIOV-VF,VLAN
- - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
+ - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+ - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
required:
- interface-name
- is-port-mirrored
description: Human friendly text regarding this interface.
is-port-mirrored:
type: boolean
+ description: boolean indicatating whether or not port is a mirrored.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
prov-status:
type: string
description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ description: Flag indicating the interface uses the IP Unnumbered configuration.
allowed-address-pairs:
type: string
description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
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)
+ - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv4-address
properties:
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)
+ - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv6-address
properties:
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)
- - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
required:
- network-id
- network-name
description: Neutron network id of this Interface
is-bound-to-vpn:
type: boolean
+ description: Set to true if bound to VPN
service-id:
type: string
description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
description: Name associated with the physical network.
is-provider-network:
type: boolean
+ description: boolean indicatating whether or not network is a provider network.
is-shared-network:
type: boolean
+ description: boolean indicatating whether or not network is a shared network.
is-external-network:
type: boolean
+ description: boolean indicatating whether or not network is an external network.
selflink:
type: string
description: Path to the controller object.
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
+
+ -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
required:
- interface-name
- in-maint
description: Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
relationship-list:
type: array
items:
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)
+ - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
required:
- link-name
properties:
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)
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
required:
- group-uuid
- resource-uuid
description: |
describes a line-of-business
###### Related Nodes
- - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
required:
- line-of-business-name
properties:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
###### Related Nodes
- - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - 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)
- - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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)
+ - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
+ - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
+ - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link IsA model-ver, Many2One)
+ - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
+ - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
required:
- link-name
- in-maint
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
link-type:
type: string
description: Type of logical link, e.g., evc
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 model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
required:
- metaname
- metaval
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
+ - TO model( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM instance-group( instance-group Targets model, MANY2MANY)
+ - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+
required:
- model-invariant-id
- model-type
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
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
+
+ -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
required:
- model-constraint-uuid
- constrained-element-set-uuid-to-replace
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
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model-ver( model-element IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
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( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
- - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
- - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ - TO model( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
+ - FROM l3-network( l3-network IsA model-ver, Many2One)
+ - FROM logical-link( logical-link IsA model-ver, Many2One)
+ - FROM service-instance( service-instance IsA model-ver, Many2One)
+ - FROM vf-module( vf-module IsA model-ver, Many2One)
+
+ -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
+ -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
+
required:
- model-version-id
- model-name
multicast-configuration:
description: |
###### Related Nodes
- - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
required:
- multicast-configuration-id
- multicast-protocol
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
required:
- named-query-uuid
- named-query-name
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
required:
- named-query-element-uuid
properties:
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)
+ - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
required:
- network-policy-id
properties:
description: |
Network profile populated by SDN-GP for SNMP
###### Related Nodes
- - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
required:
- nm-profile-name
properties:
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
+ - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
required:
- vnf-id2
- vnf-name
type: array
items:
$ref: "#/definitions/newvce"
+ nodes:
+ properties:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-item-data"
notification-event:
properties:
cambria.partition:
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)
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
required:
- network-uuid
- network-name
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)
+ - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
required:
- operational-environment-id
- operational-environment-name
description: |
describes an owning-entity
###### Related Nodes
- - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
required:
- owning-entity-id
- owning-entity-name
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
- - 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
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+ - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
required:
- interface-name
- in-maint
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
inv-status:
type: string
description: inventory status
description: |
Collection of physical connections, typically between p-interfaces
###### Related Nodes
- - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
+
+ -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
required:
- link-name
properties:
description: |
describes a platform
###### Related Nodes
- - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
required:
- platform-name
properties:
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)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
- - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
required:
- pnf-name
- in-maint
description: sw-version is the version of SW for the hosted application on the PNF.
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
frame-id:
type: string
description: ID of the physical frame (relay rack) where pnf is installed.
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
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
+
+ -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
required:
- interface-id
- orchestration-status
description: |
describes the project
###### Related Nodes
- - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
required:
- project-name
properties:
description: |
TBD
###### Related Nodes
- - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
required:
- property-constraint-uuid
- constraint-type
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
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - TO zone( pserver LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM vserver( vserver HostedOn pserver, MANY2ONE)
+
+ -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
+ -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
required:
- hostname
- in-maint
description: internet topology of Pserver
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
description: |
TBD
###### Related Nodes
- - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
required:
- related-lookup-uuid
- source-node-type
description: |
Openstack route table reference.
###### Related Nodes
- - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
required:
- route-table-reference-id
- route-table-reference-fqdn
description: |
Route target information
###### Related Nodes
- - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
required:
- global-route-target
- route-target-role
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
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
+
+ -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
required:
- routing-instance-id
properties:
description: |
Openstack segmentation assignment.
###### Related Nodes
- - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
required:
- segmentation-id
properties:
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
+ - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
+
+ -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
+
required:
- service-type
- vnf-type
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)
- - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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 forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo 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,FORWARDING-PATH
- - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance Uses configuration, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance IsA model-ver, Many2One)
+ - FROM project( project Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
+ -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
required:
- service-instance-id
- - service-type
- - service-role
- - created-at
- - updated-at
- - description
properties:
service-instance-id:
type: string
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
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
+
+ -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
required:
- service-type
properties:
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
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
required:
- site-pair-id
properties:
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
+ - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
required:
- site-pair-set-id
properties:
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)
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
required:
- snapshot-id
properties:
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)
+ - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
+ - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
required:
- pf-pci-id
properties:
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)
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+ - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
required:
- pci-id
properties:
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
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+
+ -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SUBNET is DELETED also
+ -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+
required:
- subnet-id
- dhcp-enabled
description: Orchestration status of this VNF, mastered by MSO
dhcp-enabled:
type: boolean
+ description: dhcp enabled
dhcp-start:
type: string
description: the start address reserved for use by dhcp
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
+ - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
required:
- tenant-id
- tenant-name
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)
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
required:
- id
properties:
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
+ - TO availability-zone( vce Uses availability-zone, MANY2MANY)
+ - TO complex( vce LocatedIn complex, MANY2MANY)
+ - TO vserver( vce HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
+ - FROM license( license BelongsTo vce, MANY2ONE)(1)
+ - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
+
+ -(1) IF this VCE node is deleted, this FROM node is DELETED also
required:
- vnf-id
- vnf-name
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)
- - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - VF-MODULE cannot be deleted if linked to VNFC
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module IsA model-ver, Many2One)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
required:
- vf-module-id
- is-base-vf-module
description: orchestration status of this vf-module, mastered by MSO
is-base-vf-module:
type: boolean
+ description: used to indicate whether or not this object is base vf module
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
required:
- vig-address-type
properties:
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)
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+
required:
- vip-ipv4-address
properties:
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)
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+
required:
- vip-ipv6-address
properties:
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)
+ - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
+
required:
- vdc-id
- vdc-name
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
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(1) IF this VLAN node is deleted, this FROM node is DELETED also
+ -(2) IF this VLAN node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this VLAN is DELETED also
required:
- vlan-interface
- in-maint
description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
prov-status:
type: string
description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ description: Flag indicating the interface uses the IP Unnumbered configuration.
relationship-list:
type: array
items:
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
+ - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
+
+ -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
+
required:
- vnf-image-uuid
- application
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
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
+
+ -(1) IF this VNFC node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
required:
- vnfc-name
- nfc-naming-code
description: Oam V4 vip address of this vnfc
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
group-notation:
type: string
description: Group notation of VNFC
description: |
Ephemeral Block storage volume.
###### Related Nodes
- - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
required:
- volume-id
- volume-selflink
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)
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
required:
- volume-group-id
- volume-group-name
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
+ - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
required:
- equipment-name
properties:
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
+ - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
+
+ -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
+ -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+
required:
- vpn-id
- vpn-name
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
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver Uses flavor, MANY2ONE)
+ - TO image( vserver Uses image, MANY2ONE)
+ - TO pserver( vserver HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - FROM vf-module( vf-module Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
+
+ -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
+ -(2) IF this VSERVER node is deleted, this TO node is DELETED also
required:
- vserver-id
- vserver-name
description: URL to endpoint where AAI can get more details
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: Used to indicate whether closed loop function is enabled on this node
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO complex( zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
+
required:
- zone-id
- zone-name
items:
$ref: "#/definitions/zone"
patchDefinitions:
- aai-internal:
- properties:
- property-name:
- type: string
- property-value:
- type: string
action:
properties:
action-type:
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)
- - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, 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
+ - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - TO model-ver( allotted-resource IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
required:
- id
properties:
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
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce Uses availability-zone, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
+ -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+
required:
- availability-zone-name
- hypervisor-type
class-of-service:
description: |
###### Related Nodes
- - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
required:
- cos
properties:
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 hpa-capability( hpa-capability 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,HPA-CAPABILITY,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
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
+
+ -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
+ -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+
required:
- cloud-owner
- cloud-region-id
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
cloud-extra-info:
type: string
description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
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
+ - TO l3-network( complex Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
+ - FROM zone( zone LocatedIn complex, MANY2ONE)
+
+ -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
+ -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+
required:
- physical-location-id
- physical-location-type
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)
- - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, 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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
- - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
+ - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
+ - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
+ - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
+
+ -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
+ -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
+ -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
required:
- configuration-id
- configuration-type
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
+ - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
+ - FROM service-instance( service-instance Uses connector, MANY2MANY)
+
+ -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
required:
- resource-instance-id
properties:
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
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
+
+ -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
required:
- constrained-element-set-uuid
- constraint-type
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)
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+ - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
required:
- vlan-id-inner
properties:
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)
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
required:
- target-pe
- availability-zone-name
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
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
required:
- global-customer-id
- subscriber-name
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)
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
required:
- switch-name
- vcenter-url
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
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
+
+ -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
required:
- element-choice-set-uuid
- element-choice-set-name
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)
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
required:
- group-uuid
- resource-uuid
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
required:
- ems-id
properties:
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)
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
required:
- esr-system-info-id
- user-name
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
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
required:
- thirdparty-sdnc-id
properties:
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
required:
- vnfm-id
properties:
description: |
evc object is an optional child object of the Configuration object.
###### Related Nodes
- - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
required:
- evc-id
properties:
description: |
Openstack flavor.
###### Related Nodes
- - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
+
required:
- flavor-id
- flavor-name
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
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDER is DELETED also
required:
- sequence
properties:
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)
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
required:
- forwarder-evc-id
properties:
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
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
+
+ -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
+ -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
required:
- forwarding-path-id
- forwarding-path-name
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)
- - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
+ - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform Uses generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
+ -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
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:
description: number of network in vnf.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
generic-vnfs:
description: |
Collection of VNFs
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)
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
required:
- group-id
- group-type
host-route:
description: |
###### Related Nodes
- - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
required:
- host-route-id
- route-prefix
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)
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
required:
- hpa-capability-id
- hpa-feature
hpa-version:
type: string
description: HPA schema version
- hpa-hw-arch:
+ architecture:
type: string
description: Hardware architecture
- hpa-feature-attribute:
+ hpa-feature-attributes:
description: |
HPA Capability Feature attributes
+ ###### Related Nodes
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
+ required:
+ - hpa-attribute-key
properties:
- hpa-attr-key:
+ hpa-attribute-key:
type: string
description: name of the specific HPA attribute
- hpa-attr-value:
+ 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
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
+ - FROM vserver( vserver Uses image, MANY2ONE)
+
+ -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
+ -IMAGE cannot be deleted if related to VSERVER
+
required:
- image-id
- image-name
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)
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
+
required:
- - instance-group-role
- - model-invariant-id
- - model-version-id
- id
- description
- type
network:
type: object
$ref: "#/patchDefinitions/network"
- aai-internal:
- type: object
- $ref: "#/patchDefinitions/aai-internal"
nodes:
- type: array
- items:
- $ref: "#/patchDefinitions/aai-internal"
+ type: object
+ $ref: "#/patchDefinitions/nodes"
inventory-item:
properties:
inventory-item-type:
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
+ - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
required:
- ipsec-configuration-id
properties:
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 logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
- - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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,LOGICAL-LINK,SRIOV-VF,VLAN
- - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
+ - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+ - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
required:
- interface-name
- is-port-mirrored
description: Human friendly text regarding this interface.
is-port-mirrored:
type: boolean
+ description: boolean indicatating whether or not port is a mirrored.
l-interfaces:
description: |
Collection of logical interfaces.
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)
+ - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv4-address
properties:
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)
+ - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv6-address
properties:
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)
- - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
required:
- network-id
- network-name
description: Neutron network id of this Interface
is-bound-to-vpn:
type: boolean
+ description: Set to true if bound to VPN
service-id:
type: string
description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
+
+ -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
required:
- interface-name
- in-maint
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)
+ - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
required:
- link-name
properties:
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)
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
required:
- group-uuid
- resource-uuid
description: |
describes a line-of-business
###### Related Nodes
- - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
required:
- line-of-business-name
properties:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
###### Related Nodes
- - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - 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)
- - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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)
+ - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
+ - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
+ - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link IsA model-ver, Many2One)
+ - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
+ - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
required:
- link-name
- in-maint
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
link-type:
type: string
description: Type of logical link, e.g., evc
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 model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
required:
- metaname
- metaval
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
+ - TO model( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM instance-group( instance-group Targets model, MANY2MANY)
+ - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+
required:
- model-invariant-id
- model-type
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
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
+
+ -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
required:
- model-constraint-uuid
- constrained-element-set-uuid-to-replace
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
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model-ver( model-element IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
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( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
- - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
- - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ - TO model( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
+ - FROM l3-network( l3-network IsA model-ver, Many2One)
+ - FROM logical-link( logical-link IsA model-ver, Many2One)
+ - FROM service-instance( service-instance IsA model-ver, Many2One)
+ - FROM vf-module( vf-module IsA model-ver, Many2One)
+
+ -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
+ -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
+
required:
- model-version-id
- model-name
multicast-configuration:
description: |
###### Related Nodes
- - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
required:
- multicast-configuration-id
- multicast-protocol
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
required:
- named-query-uuid
- named-query-name
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
required:
- named-query-element-uuid
properties:
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)
+ - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
required:
- network-policy-id
properties:
description: |
Network profile populated by SDN-GP for SNMP
###### Related Nodes
- - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
required:
- nm-profile-name
properties:
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
+ - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
required:
- vnf-id2
- vnf-name
type: array
items:
$ref: "#/patchDefinitions/newvce"
+ nodes:
+ properties:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item-data"
notification-event:
properties:
cambria.partition:
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)
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
required:
- network-uuid
- network-name
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)
+ - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
required:
- operational-environment-id
- operational-environment-name
description: |
describes an owning-entity
###### Related Nodes
- - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
required:
- owning-entity-id
- owning-entity-name
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
- - 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
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+ - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
required:
- interface-name
- in-maint
description: |
Collection of physical connections, typically between p-interfaces
###### Related Nodes
- - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
+
+ -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
required:
- link-name
properties:
description: |
describes a platform
###### Related Nodes
- - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
required:
- platform-name
properties:
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)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
- - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
required:
- pnf-name
- in-maint
description: sw-version is the version of SW for the hosted application on the PNF.
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
frame-id:
type: string
description: ID of the physical frame (relay rack) where pnf is installed.
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
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
+
+ -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
required:
- interface-id
- orchestration-status
description: |
describes the project
###### Related Nodes
- - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
required:
- project-name
properties:
description: |
TBD
###### Related Nodes
- - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
required:
- property-constraint-uuid
- constraint-type
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
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - TO zone( pserver LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM vserver( vserver HostedOn pserver, MANY2ONE)
+
+ -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
+ -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
required:
- hostname
- in-maint
description: internet topology of Pserver
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
pservers:
description: |
Collection of compute hosts.
description: |
TBD
###### Related Nodes
- - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
required:
- related-lookup-uuid
- source-node-type
description: |
Openstack route table reference.
###### Related Nodes
- - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
required:
- route-table-reference-id
- route-table-reference-fqdn
description: |
Route target information
###### Related Nodes
- - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
required:
- global-route-target
- route-target-role
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
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
+
+ -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
required:
- routing-instance-id
properties:
description: |
Openstack segmentation assignment.
###### Related Nodes
- - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
required:
- segmentation-id
properties:
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
+ - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
+
+ -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
+
required:
- service-type
- vnf-type
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)
- - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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 forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo 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,FORWARDING-PATH
- - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance Uses configuration, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance IsA model-ver, Many2One)
+ - FROM project( project Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
+ -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
required:
- service-instance-id
- - service-type
- - service-role
- - created-at
- - updated-at
- - description
properties:
service-instance-id:
type: string
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
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
+
+ -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
required:
- service-type
properties:
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
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
required:
- site-pair-id
properties:
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
+ - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
required:
- site-pair-set-id
properties:
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)
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
required:
- snapshot-id
properties:
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)
+ - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
+ - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
required:
- pf-pci-id
properties:
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)
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+ - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
required:
- pci-id
properties:
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
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+
+ -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SUBNET is DELETED also
+ -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+
required:
- subnet-id
- dhcp-enabled
description: Orchestration status of this VNF, mastered by MSO
dhcp-enabled:
type: boolean
+ description: dhcp enabled
dhcp-start:
type: string
description: the start address reserved for use by dhcp
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
+ - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
required:
- tenant-id
- tenant-name
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)
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
required:
- id
properties:
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
+ - TO availability-zone( vce Uses availability-zone, MANY2MANY)
+ - TO complex( vce LocatedIn complex, MANY2MANY)
+ - TO vserver( vce HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
+ - FROM license( license BelongsTo vce, MANY2ONE)(1)
+ - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
+
+ -(1) IF this VCE node is deleted, this FROM node is DELETED also
required:
- vnf-id
- vnf-name
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)
- - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - VF-MODULE cannot be deleted if linked to VNFC
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module IsA model-ver, Many2One)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
required:
- vf-module-id
- is-base-vf-module
description: orchestration status of this vf-module, mastered by MSO
is-base-vf-module:
type: boolean
+ description: used to indicate whether or not this object is base vf module
vf-modules:
description: |
Collection of vf-modules, a deployment unit of VNFCs
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)
+ - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
required:
- vig-address-type
properties:
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)
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+
required:
- vip-ipv4-address
properties:
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)
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+
required:
- vip-ipv6-address
properties:
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)
+ - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
+
required:
- vdc-id
- vdc-name
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
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(1) IF this VLAN node is deleted, this FROM node is DELETED also
+ -(2) IF this VLAN node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this VLAN is DELETED also
required:
- vlan-interface
- in-maint
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
+ - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
+
+ -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
+
required:
- vnf-image-uuid
- application
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
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
+
+ -(1) IF this VNFC node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
required:
- vnfc-name
- nfc-naming-code
description: Oam V4 vip address of this vnfc
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
group-notation:
type: string
description: Group notation of VNFC
description: |
Ephemeral Block storage volume.
###### Related Nodes
- - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
required:
- volume-id
- volume-selflink
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)
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
required:
- volume-group-id
- volume-group-name
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
+ - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
required:
- equipment-name
properties:
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
+ - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
+
+ -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
+ -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+
required:
- vpn-id
- vpn-name
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
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver Uses flavor, MANY2ONE)
+ - TO image( vserver Uses image, MANY2ONE)
+ - TO pserver( vserver HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - FROM vf-module( vf-module Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
+
+ -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
+ -(2) IF this VSERVER node is deleted, this TO node is DELETED also
required:
- vserver-id
- vserver-name
description: URL to endpoint where AAI can get more details
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: Used to indicate whether closed loop function is enabled on this node
vservers:
description: |
Collection of virtual Servers, aka virtual machines or VMs.
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)
+ - TO complex( zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
+
required:
- zone-id
- zone-name
items:
$ref: "#/patchDefinitions/zone"
getDefinitions:
- aai-internal:
- properties:
- property-name:
- type: string
- property-value:
- type: string
action:
properties:
action-type:
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)
- - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, 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
+ - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
+ - TO model-ver( allotted-resource IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
+ - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
+ - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
+
+ -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
+ -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
+ -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
required:
- id
properties:
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
+ - TO complex( availability-zone LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
+ - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce Uses availability-zone, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
+ -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+
required:
- availability-zone-name
- hypervisor-type
class-of-service:
description: |
###### Related Nodes
- - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
required:
- cos
properties:
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 hpa-capability( hpa-capability 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,HPA-CAPABILITY,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
+ - TO complex( cloud-region LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
+ - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
+
+ -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
+ -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+
required:
- cloud-owner
- cloud-region-id
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
cloud-extra-info:
type: string
description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
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
+ - TO l3-network( complex Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver LocatedIn complex, MANY2ONE)
+ - FROM vce( vce LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
+ - FROM zone( zone LocatedIn complex, MANY2ONE)
+
+ -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
+ -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+
required:
- physical-location-id
- physical-location-type
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)
- - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, 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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
- - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
- - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
- - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
+ - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
+ - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
+ - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
+ - FROM service-instance( service-instance Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
+ - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
+ - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
+ - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
+
+ -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
+ -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
+ -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
required:
- configuration-id
- configuration-type
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
+ - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
+ - FROM service-instance( service-instance Uses connector, MANY2MANY)
+
+ -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
required:
- resource-instance-id
properties:
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
+ - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
+ - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
+ - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
+
+ -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
required:
- constrained-element-set-uuid
- constraint-type
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)
+ - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
+ - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
required:
- vlan-id-inner
properties:
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)
+ - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
+ - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
+
+ -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
required:
- target-pe
- availability-zone-name
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
+ - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
+
+ -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
required:
- global-customer-id
- subscriber-name
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)
+ - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
+
required:
- switch-name
- vcenter-url
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
+ - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
+ - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
+
+ -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
required:
- element-choice-set-uuid
- element-choice-set-name
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)
+ - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
required:
- group-uuid
- resource-uuid
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
+
+ -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
required:
- ems-id
properties:
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)
+ - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
+ - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
+ - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
+ - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
required:
- esr-system-info-id
- user-name
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
+ - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
+
+ -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
required:
- thirdparty-sdnc-id
properties:
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
+ - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
+
+ -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
required:
- vnfm-id
properties:
description: |
evc object is an optional child object of the Configuration object.
###### Related Nodes
- - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this EVC is DELETED also
required:
- evc-id
properties:
description: |
Openstack flavor.
###### Related Nodes
- - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
+ - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
+ - FROM vserver( vserver Uses flavor, MANY2ONE)
+
+ -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
+
required:
- flavor-id
- flavor-name
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
+ - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
+ - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
+ - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDER is DELETED also
required:
- sequence
properties:
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)
+ - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
required:
- forwarder-evc-id
properties:
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
+ - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
+ - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
+ - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
+
+ -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
+ -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
required:
- forwarding-path-id
- forwarding-path-name
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)
- - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
+ - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
+ - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform Uses generic-vnf, MANY2MANY)
+
+ -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
+ -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
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:
description: number of network in vnf.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
+
required:
- group-id
- group-type
host-route:
description: |
###### Related Nodes
- - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
required:
- host-route-id
- route-prefix
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)
+ - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
+
+ -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
required:
- hpa-capability-id
- hpa-feature
hpa-version:
type: string
description: HPA schema version
- hpa-hw-arch:
+ architecture:
type: string
description: Hardware architecture
resource-version:
type: array
items:
$ref: "#/getDefinitions/relationship"
- hpa-feature-attribute:
+ hpa-feature-attributes:
type: array
items:
- $ref: "#/getDefinitions/hpa-feature-attribute"
- hpa-feature-attribute:
+ $ref: "#/getDefinitions/hpa-feature-attributes"
+ hpa-feature-attributes:
description: |
HPA Capability Feature attributes
+ ###### Related Nodes
+ - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
+ required:
+ - hpa-attribute-key
properties:
- hpa-attr-key:
+ hpa-attribute-key:
type: string
description: name of the specific HPA attribute
- hpa-attr-value:
+ hpa-attribute-value:
type: string
description: JSON string specifying the value, unit and type of the specific HPA attribute
resource-version:
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
+ - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
+ - FROM vserver( vserver Uses image, MANY2ONE)
+
+ -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
+ -IMAGE cannot be deleted if related to VSERVER
+
required:
- image-id
- image-name
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)
+ - TO model( instance-group Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
+
required:
- - instance-group-role
- - model-invariant-id
- - model-version-id
- id
- description
- type
network:
type: object
$ref: "#/getDefinitions/network"
- aai-internal:
- type: object
- $ref: "#/getDefinitions/aai-internal"
nodes:
- type: array
- items:
- $ref: "#/getDefinitions/aai-internal"
+ type: object
+ $ref: "#/getDefinitions/nodes"
inventory-item:
properties:
inventory-item-type:
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
+ - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
+
+ -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
required:
- ipsec-configuration-id
properties:
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 logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
- - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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,LOGICAL-LINK,SRIOV-VF,VLAN
- - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
+ - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+ - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
+ - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
+ - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
+ - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
+ - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
+ - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
+ - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
+ - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
+ - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
+ - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
+
+ -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
required:
- interface-name
- is-port-mirrored
description: Human friendly text regarding this interface.
is-port-mirrored:
type: boolean
+ description: boolean indicatating whether or not port is a mirrored.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
prov-status:
type: string
description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ description: Flag indicating the interface uses the IP Unnumbered configuration.
allowed-address-pairs:
type: string
description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
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)
+ - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv4-address
properties:
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)
+ - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
+ - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
+ - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
required:
- l3-interface-ipv6-address
properties:
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)
- - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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
+ - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
+ - FROM complex( complex Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
+ - FROM tenant( tenant Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
+
+ -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
required:
- network-id
- network-name
description: Neutron network id of this Interface
is-bound-to-vpn:
type: boolean
+ description: Set to true if bound to VPN
service-id:
type: string
description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
description: Name associated with the physical network.
is-provider-network:
type: boolean
+ description: boolean indicatating whether or not network is a provider network.
is-shared-network:
type: boolean
+ description: boolean indicatating whether or not network is a shared network.
is-external-network:
type: boolean
+ description: boolean indicatating whether or not network is an external network.
selflink:
type: string
description: Path to the controller object.
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo 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
+ - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
+ - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
+ - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
+
+ -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
required:
- interface-name
- in-maint
description: Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
relationship-list:
type: array
items:
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)
+ - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
required:
- link-name
properties:
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)
+ - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO vce( license BelongsTo vce, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this LICENSE is DELETED also
required:
- group-uuid
- resource-uuid
description: |
describes a line-of-business
###### Related Nodes
- - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
+
required:
- line-of-business-name
properties:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
###### Related Nodes
- - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
- - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
- - 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)
- - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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)
+ - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
+ - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
+ - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link IsA model-ver, Many2One)
+ - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
+ - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
+ - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
+ - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
+ - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
+ - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
+
+ -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
+ -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
required:
- link-name
- in-maint
description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
link-type:
type: string
description: Type of logical link, e.g., evc
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 model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
+ - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
+ - TO image( metadatum BelongsTo image, MANY2ONE)(4)
+ - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
+ - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this METADATUM is DELETED also
required:
- metaname
- metaval
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
+ - TO model( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM instance-group( instance-group Targets model, MANY2MANY)
+ - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
+ - FROM named-query( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element IsA model, MANY2ONE)
+
+ -(1) IF this MODEL node is deleted, this FROM node is DELETED also
+ -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+
required:
- model-invariant-id
- model-type
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
+ - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
+
+ -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
required:
- model-constraint-uuid
- constrained-element-set-uuid-to-replace
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
+ - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
+ - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+ - TO model-ver( model-element IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
+ - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
+
+ -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
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( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
- - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
- - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
- - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ - TO model( model-ver BelongsTo model, MANY2ONE)(4)
+ - FROM model-element( model-element IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
+ - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
+ - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
+ - FROM l3-network( l3-network IsA model-ver, Many2One)
+ - FROM logical-link( logical-link IsA model-ver, Many2One)
+ - FROM service-instance( service-instance IsA model-ver, Many2One)
+ - FROM vf-module( vf-module IsA model-ver, Many2One)
+
+ -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
+ -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
+
required:
- model-version-id
- model-name
multicast-configuration:
description: |
###### Related Nodes
- - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
+
required:
- multicast-configuration-id
- multicast-protocol
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
+ - TO model( named-query AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
+
+ -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
required:
- named-query-uuid
- named-query-name
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
+ - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
+ - TO model( named-query-element IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+ - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
+ - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
required:
- named-query-element-uuid
properties:
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)
+ - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
+
required:
- network-policy-id
properties:
description: |
Network profile populated by SDN-GP for SNMP
###### Related Nodes
- - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
+
required:
- nm-profile-name
properties:
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
+ - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
+
+ -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
required:
- vnf-id2
- vnf-name
type: array
items:
$ref: "#/getDefinitions/newvce"
+ nodes:
+ properties:
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item-data"
notification-event:
properties:
cambria.partition:
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)
+ - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
+
required:
- network-uuid
- network-name
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)
+ - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
+
required:
- operational-environment-id
- operational-environment-name
description: |
describes an owning-entity
###### Related Nodes
- - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
+
required:
- owning-entity-id
- owning-entity-name
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)
- - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
- - 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
+ - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
+ - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
+ - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
+ - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
+ - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
+ - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
+ - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
+
+ -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
+ -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
required:
- interface-name
- in-maint
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
inv-status:
type: string
description: inventory status
description: |
Collection of physical connections, typically between p-interfaces
###### Related Nodes
- - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
+
+ -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
required:
- link-name
properties:
description: |
describes a platform
###### Related Nodes
- - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
+
required:
- platform-name
properties:
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)
- - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
- - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - TO complex( pnf LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
+ - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
+
+ -(1) IF this PNF node is deleted, this FROM node is DELETED also
required:
- pnf-name
- in-maint
description: sw-version is the version of SW for the hosted application on the PNF.
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
frame-id:
type: string
description: ID of the physical frame (relay rack) where pnf is installed.
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
+ - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
+ - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
+
+ -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
required:
- interface-id
- orchestration-status
description: |
describes the project
###### Related Nodes
- - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - TO service-instance( project Uses service-instance, ONE2MANY)
+
required:
- project-name
properties:
description: |
TBD
###### Related Nodes
- - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
required:
- property-constraint-uuid
- constraint-type
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
+ - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver LocatedIn complex, MANY2ONE)
+ - TO zone( pserver LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
+ - FROM vserver( vserver HostedOn pserver, MANY2ONE)
+
+ -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
+ -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
+
required:
- hostname
- in-maint
description: internet topology of Pserver
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
description: |
TBD
###### Related Nodes
- - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
required:
- related-lookup-uuid
- source-node-type
description: |
Openstack route table reference.
###### Related Nodes
- - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
+
required:
- route-table-reference-id
- route-table-reference-fqdn
description: |
Route target information
###### Related Nodes
- - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
required:
- global-route-target
- route-target-role
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
+ - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
+ - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
+
+ -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
required:
- routing-instance-id
properties:
description: |
Openstack segmentation assignment.
###### Related Nodes
- - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
required:
- segmentation-id
properties:
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
+ - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
+
+ -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
+
required:
- service-type
- vnf-type
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)
- - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
- - 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 forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo 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,FORWARDING-PATH
- - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance Uses configuration, ONE2MANY)
+ - TO connector( service-instance Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
+ - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
+ - TO vce( service-instance ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance IsA model-ver, Many2One)
+ - FROM project( project Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
+ - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
+ - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
+
+ -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
+ -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
required:
- service-instance-id
- - service-type
- - service-role
- - created-at
- - updated-at
- - description
properties:
service-instance-id:
type: string
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
+ - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
+ - TO tenant( service-subscription Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
+
+ -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
required:
- service-type
properties:
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
+ - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
+ - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
required:
- site-pair-id
properties:
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
+ - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
+
+ -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
required:
- site-pair-set-id
properties:
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)
+ - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver Uses snapshot, ONE2ONE)
+
required:
- snapshot-id
properties:
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)
+ - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
+ - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
required:
- pf-pci-id
properties:
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)
+ - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
+ - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
+
+ -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
required:
- pci-id
properties:
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
+ - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+
+ -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this SUBNET is DELETED also
+ -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+
required:
- subnet-id
- dhcp-enabled
description: Orchestration status of this VNF, mastered by MSO
dhcp-enabled:
type: boolean
+ description: dhcp enabled
dhcp-start:
type: string
description: the start address reserved for use by dhcp
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
+ - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
+ - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
+
+ -TENANT cannot be deleted if related to VSERVER
+
required:
- tenant-id
- tenant-name
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)
+ - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
+
+ -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
required:
- id
properties:
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
+ - TO availability-zone( vce Uses availability-zone, MANY2MANY)
+ - TO complex( vce LocatedIn complex, MANY2MANY)
+ - TO vserver( vce HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
+ - FROM license( license BelongsTo vce, MANY2ONE)(1)
+ - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
+ - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
+
+ -(1) IF this VCE node is deleted, this FROM node is DELETED also
required:
- vnf-id
- vnf-name
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)
- - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
- - VF-MODULE cannot be deleted if linked to VNFC
+ - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module IsA model-ver, Many2One)
+
+ -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
+ -VF-MODULE cannot be deleted if related to VNFC
+
required:
- vf-module-id
- is-base-vf-module
description: orchestration status of this vf-module, mastered by MSO
is-base-vf-module:
type: boolean
+ description: used to indicate whether or not this object is base vf module
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
+
+ -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
required:
- vig-address-type
properties:
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)
+ - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+
required:
- vip-ipv4-address
properties:
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)
+ - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+
required:
- vip-ipv6-address
properties:
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)
+ - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
+
required:
- vdc-id
- vdc-name
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
+ - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
+ - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
+ - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
+
+ -(1) IF this VLAN node is deleted, this FROM node is DELETED also
+ -(2) IF this VLAN node is deleted, this TO node is DELETED also
+ -(4) IF this TO node is deleted, this VLAN is DELETED also
required:
- vlan-interface
- in-maint
description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
prov-status:
type: string
description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ description: Flag indicating the interface uses the IP Unnumbered configuration.
relationship-list:
type: array
items:
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
+ - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
+
+ -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
+
required:
- vnf-image-uuid
- application
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
+ - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
+ - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
+
+ -(1) IF this VNFC node is deleted, this FROM node is DELETED also
+ -(4) IF this TO node is deleted, this VNFC is DELETED also
required:
- vnfc-name
- nfc-naming-code
description: Oam V4 vip address of this vnfc
in-maint:
type: boolean
+ description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
is-closed-loop-disabled:
type: boolean
+ description: used to indicate whether closed loop function is enabled on this node
group-notation:
type: string
description: Group notation of VNFC
description: |
Ephemeral Block storage volume.
###### Related Nodes
- - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
+
+ -(3) IF this FROM node is deleted, this VOLUME is DELETED also
required:
- volume-id
- volume-selflink
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)
+ - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
+
required:
- volume-group-id
- volume-group-name
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
+ - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
+ - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
+
+ -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
required:
- equipment-name
properties:
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
+ - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
+
+ -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
+ -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+
required:
- vpn-id
- vpn-name
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
+ - TO tenant( vserver BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver Uses flavor, MANY2ONE)
+ - TO image( vserver Uses image, MANY2ONE)
+ - TO pserver( vserver HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
+ - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
+ - FROM vce( vce HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
+ - FROM vf-module( vf-module Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
+
+ -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
+ -(2) IF this VSERVER node is deleted, this TO node is DELETED also
required:
- vserver-id
- vserver-name
description: URL to endpoint where AAI can get more details
in-maint:
type: boolean
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
is-closed-loop-disabled:
type: boolean
+ description: Used to indicate whether closed loop function is enabled on this node
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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)
+ - TO complex( zone LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
+
required:
- zone-id
- zone-name