From f1a8fb1bc04f5d685f2b31d35db605f6fa054f60 Mon Sep 17 00:00:00 2001 From: "Kajur, Harish (vk250x)" Date: Sat, 24 Mar 2018 21:59:03 -0400 Subject: Add plugin to check coverage Get line coverage to 50% and ensure it doesn't go down Issue-ID: AAI-498 Change-Id: Ib466b7e2b7cb6d2f888e3b58c2073bb02ab6f809 Signed-off-by: Kajur, Harish (vk250x) --- .../aai_swagger_yaml/aai_swagger_v10.yaml | 15191 +++++------------ .../aai_swagger_yaml/aai_swagger_v11.yaml | 16406 +++++------------- .../aai_swagger_yaml/aai_swagger_v12.yaml | 16539 +++++-------------- .../aai_swagger_yaml/aai_swagger_v13.yaml | 16539 +++++-------------- .../resources/aai_swagger_yaml/aai_swagger_v8.yaml | 11895 ++++--------- .../resources/aai_swagger_yaml/aai_swagger_v9.yaml | 13562 +++++---------- 6 files changed, 25175 insertions(+), 64957 deletions(-) (limited to 'aai-schema/src/main/resources/aai_swagger_yaml') diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v10.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v10.yaml index ac8969de..797e5d9b 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v10.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v10.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 @@ -756,7 +712,7 @@ paths: 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" @@ -829,209 +785,32 @@ paths: 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/v10/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 + - name: volume-group-id in: query - description: Readable name of tenant + 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 @@ -1074,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/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 @@ -1135,25 +903,21 @@ paths: 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: @@ -1187,26 +951,22 @@ paths: 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: @@ -1234,50 +994,35 @@ paths: 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: 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/v10/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 @@ -1312,18 +1057,24 @@ paths: 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/v10/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 @@ -1358,19 +1109,32 @@ paths: 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: @@ -1398,21 +1162,54 @@ paths: 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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1421,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1456,24 +1253,12 @@ paths: 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 @@ -1520,15 +1305,9 @@ paths: 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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1537,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1584,27 +1363,19 @@ paths: 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: @@ -1650,86 +1421,130 @@ paths: 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/v10/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: vserver-name - in: query - description: Name of vserver - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + 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: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-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-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: network-name - in: query - description: Name of the network - 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: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __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: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - 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: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure @@ -1868,7 +1683,7 @@ paths: 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" @@ -2117,86 +1932,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - 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 @@ -2335,7 +2070,7 @@ paths: 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" @@ -2456,70 +2191,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -2646,7 +2317,7 @@ paths: 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" @@ -2755,57 +2426,20 @@ paths: 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: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -2972,79 +2606,6 @@ paths: 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: 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 @@ -3171,7 +2732,7 @@ paths: 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" @@ -3280,57 +2841,29 @@ paths: 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: 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: @@ -3595,84 +3128,84 @@ paths: 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: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list + summary: update an existing l3-interface-ipv4-address-list description: | - Create or update an existing l3-interface-ipv4-address-list. + Update an existing l3-interface-ipv4-address-list # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -3721,76 +3254,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv4-address-list - description: | - Update an existing l3-interface-ipv4-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -4015,75 +3479,6 @@ paths: 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: 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 @@ -4210,7 +3605,7 @@ paths: 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" @@ -4319,59 +3714,6 @@ paths: 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: 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 @@ -4486,7 +3828,7 @@ paths: 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" @@ -4583,44 +3925,26 @@ paths: 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 + - name: interface-name in: query - description: Readable name of tenant + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -4663,44 +3987,6 @@ paths: 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: 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 @@ -4803,7 +4089,7 @@ paths: 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" @@ -4888,21 +4174,36 @@ paths: 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: + required: false + type: string + - name: prov-status in: query - description: Readable name of tenant + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -5013,21 +4314,6 @@ paths: 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 put: tags: - CloudInfrastructure @@ -5118,7 +4404,7 @@ paths: 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" @@ -5191,14 +4477,14 @@ paths: 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -5311,21 +4597,6 @@ paths: 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: Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -5416,7 +4687,7 @@ paths: 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" @@ -5489,14 +4760,14 @@ paths: 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: @@ -5609,26 +4880,6 @@ paths: 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 @@ -5719,7 +4970,7 @@ paths: 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" @@ -5792,14 +5043,19 @@ paths: 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: @@ -5912,41 +5168,6 @@ paths: 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 @@ -6037,7 +5258,7 @@ paths: 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" @@ -6110,14 +5331,34 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -6235,36 +5476,6 @@ paths: 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 @@ -6365,7 +5576,7 @@ paths: 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" @@ -6449,34 +5660,9 @@ paths: 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}: @@ -6515,36 +5701,6 @@ paths: 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 @@ -6635,7 +5791,7 @@ paths: 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" @@ -6708,14 +5864,29 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -6828,21 +5999,6 @@ paths: 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 @@ -6933,7 +6089,7 @@ paths: 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" @@ -7006,14 +6162,14 @@ paths: 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: @@ -7126,27 +6282,6 @@ paths: 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 @@ -7237,7 +6372,7 @@ paths: 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" @@ -7310,16 +6445,22 @@ paths: 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: @@ -7430,16 +6571,6 @@ paths: 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 @@ -7530,7 +6661,7 @@ paths: 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" @@ -7603,14 +6734,9 @@ paths: 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: @@ -7705,16 +6831,6 @@ paths: 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 @@ -7793,7 +6909,7 @@ paths: 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" @@ -7847,6 +6963,27 @@ paths: $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: @@ -7987,7 +7124,7 @@ paths: 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" @@ -8035,6 +7172,12 @@ paths: $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: @@ -8379,72 +7522,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8559,7 +7636,7 @@ paths: 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" @@ -8760,72 +7837,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8940,7 +7951,7 @@ paths: 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" @@ -9037,56 +8048,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -9189,7 +8150,7 @@ paths: 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" @@ -9274,43 +8235,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -9414,165 +8352,106 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/sriov-vf" - "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: 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: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string - put: - tags: - - CloudInfrastructure - summary: 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/v10/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__ + 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 + 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/v10/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: @@ -9602,7 +8481,7 @@ paths: 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" @@ -9687,43 +8566,29 @@ paths: 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: @@ -9928,61 +8793,6 @@ paths: 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 @@ -10085,7 +8895,7 @@ paths: 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" @@ -10262,61 +9072,6 @@ paths: 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 @@ -10419,7 +9174,7 @@ paths: 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" @@ -10504,45 +9259,6 @@ paths: 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 @@ -10633,7 +9349,7 @@ paths: 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" @@ -10706,28 +9422,24 @@ paths: 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}: @@ -10760,30 +9472,6 @@ paths: 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 @@ -10862,7 +9550,7 @@ paths: 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" @@ -10923,23 +9611,14 @@ paths: 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: @@ -11236,77 +9915,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11421,7 +10029,7 @@ paths: 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" @@ -11622,77 +10230,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11807,7 +10344,7 @@ paths: 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" @@ -11904,61 +10441,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -12061,7 +10543,7 @@ paths: 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" @@ -12146,48 +10628,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -12318,70 +10772,6 @@ paths: 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 @@ -12484,7 +10874,7 @@ paths: 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" @@ -12569,48 +10959,29 @@ paths: 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: @@ -12815,66 +11186,6 @@ paths: 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 @@ -12977,7 +11288,7 @@ paths: 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" @@ -13154,66 +11465,6 @@ paths: 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 @@ -13316,7 +11567,7 @@ paths: 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" @@ -13401,50 +11652,6 @@ paths: 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 @@ -13535,7 +11742,7 @@ paths: 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" @@ -13608,33 +11815,24 @@ paths: 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}: @@ -13667,35 +11865,6 @@ paths: 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 @@ -13774,7 +11943,7 @@ paths: 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" @@ -13835,23 +12004,19 @@ paths: 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}: @@ -13878,25 +12043,6 @@ paths: 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 @@ -13963,7 +12109,7 @@ paths: 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" @@ -14011,6 +12157,32 @@ paths: $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: @@ -14085,11 +12257,6 @@ paths: 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 @@ -14156,7 +12323,7 @@ paths: 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" @@ -14204,6 +12371,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -14283,26 +12461,6 @@ paths: 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 @@ -14379,7 +12537,7 @@ paths: 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" @@ -14439,24 +12597,9 @@ paths: 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}: @@ -14483,26 +12626,6 @@ paths: 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 @@ -14569,7 +12692,7 @@ paths: 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" @@ -14617,175 +12740,38 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: - put: - tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - 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__ - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: - get: - tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/metadatum" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: 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: 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 + - name: resource-instance-id in: query - description: This field will store a name 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. + 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. - 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}/relationship-list/relationship: 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 + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship consumes: - application/json - application/xml @@ -14814,34 +12800,96 @@ paths: 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. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true schema: - $ref: "#/definitions/metadatum" - patch: + $ref: "#/definitions/relationship" + delete: 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 + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - 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__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: 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__ + 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 @@ -14877,7 +12925,63 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -14961,49 +13065,9 @@ paths: 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: 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 + - name: metaname 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: @@ -15152,71 +13216,6 @@ paths: 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: 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 @@ -15331,7 +13330,7 @@ paths: 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" @@ -15428,69 +13427,9 @@ paths: 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: 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: @@ -15621,71 +13560,6 @@ paths: 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: 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 @@ -15788,7 +13662,7 @@ paths: 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" @@ -15873,49 +13747,29 @@ paths: 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 + - name: id in: query - description: This field will store a name 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}: @@ -15954,51 +13808,6 @@ paths: 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: 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 @@ -16089,7 +13898,7 @@ paths: 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" @@ -16162,14 +13971,44 @@ paths: 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: 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: @@ -16264,16 +14103,6 @@ paths: 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 @@ -16352,7 +14181,7 @@ paths: 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" @@ -16413,14 +14242,9 @@ paths: 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: @@ -16497,16 +14321,6 @@ paths: 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 @@ -16573,7 +14387,7 @@ paths: 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" @@ -16621,6 +14435,22 @@ paths: $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: @@ -16695,21 +14525,6 @@ paths: 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 @@ -16776,7 +14591,7 @@ paths: 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" @@ -16824,6 +14639,27 @@ paths: $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: @@ -16898,11 +14734,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -16969,7 +14800,7 @@ paths: 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" @@ -17017,6 +14848,17 @@ paths: $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: @@ -17187,7 +15029,7 @@ paths: 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" @@ -17241,6 +15083,17 @@ paths: $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: @@ -17393,21 +15246,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -17526,7 +15364,7 @@ paths: 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" @@ -17628,19 +15466,9 @@ paths: 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 + - name: element-choice-set-uuid in: query - description: Version + 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: @@ -17780,21 +15608,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -17903,7 +15716,7 @@ paths: 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" @@ -17995,19 +15808,9 @@ paths: 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 + - name: constrained-element-set-uuid in: query - description: Version + 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}: @@ -18050,21 +15853,6 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18163,7 +15951,7 @@ paths: 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" @@ -18245,19 +16033,9 @@ paths: 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 + - name: model-constraint-uuid in: query - description: Version + 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: @@ -18367,21 +16145,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18470,7 +16233,7 @@ paths: 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" @@ -18542,19 +16305,9 @@ paths: 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 + - name: model-element-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: @@ -18592,21 +16345,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18695,7 +16433,7 @@ paths: 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" @@ -18767,19 +16505,9 @@ paths: 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 + - name: metaname in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: @@ -18874,21 +16602,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18967,7 +16680,7 @@ paths: 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" @@ -19028,9 +16741,19 @@ paths: 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: 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: @@ -19107,11 +16830,6 @@ paths: 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 @@ -19178,7 +16896,7 @@ paths: 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" @@ -19226,6 +16944,17 @@ paths: $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: @@ -19327,10 +17056,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19415,7 +17140,7 @@ paths: 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" @@ -19483,8 +17208,9 @@ paths: 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}: @@ -19520,10 +17246,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19608,7 +17330,7 @@ paths: 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" @@ -19676,8 +17398,9 @@ paths: 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: @@ -19766,10 +17489,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19844,7 +17563,7 @@ paths: 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" @@ -19902,8 +17621,9 @@ paths: 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: @@ -19977,10 +17697,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20045,7 +17761,7 @@ paths: 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" @@ -20092,6 +17808,17 @@ paths: $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: @@ -20166,160 +17893,166 @@ paths: required: true type: string example: __LINK-NAME__ + put: + tags: + - Network + summary: create or update an existing logical-link + description: | + Create or update an existing logical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json) + required: true + schema: + $ref: "#/definitions/logical-link" + patch: + tags: + - Network + summary: update an existing logical-link + description: | + Update an existing logical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/logical-link" + delete: + tags: + - Network + summary: delete an existing logical-link + description: delete an existing logical-link + operationId: deleteNetworkLogicalLinksLogicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/logical-links: + get: + tags: + - Network + summary: returns logical-links + description: returns logical-links + operationId: getNetworkLogicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/logical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string - name: 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: prov-status in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - name: link-id in: query - description: UUID of the logical-link, SDNC generates this. + description: required: false type: string - name: circuit-id in: query - description: Circuit id + description: required: false type: string - name: purpose in: query - description: Reason for this entity, role it is playing + description: required: false type: string - put: - tags: - - Network - summary: create or update an existing logical-link - description: | - Create or update an existing logical-link. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkLogicalLinksLogicalLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name - in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ - required: true - type: string - example: __LINK-NAME__ - - name: body - in: body - description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json) - required: true - schema: - $ref: "#/definitions/logical-link" - patch: - tags: - - Network - summary: update an existing logical-link - description: | - Update an existing logical-link - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkLogicalLinksLogicalLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name - in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ - required: true - type: string - example: __LINK-NAME__ - - name: body - in: body - description: logical-link object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/logical-link" - delete: - tags: - - Network - summary: delete an existing logical-link - description: delete an existing logical-link - operationId: deleteNetworkLogicalLinksLogicalLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name - in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ - required: true - type: string - example: __LINK-NAME__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/logical-links: - get: - tags: - - Network - summary: returns logical-links - description: returns logical-links - operationId: getNetworkLogicalLinks - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $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: @@ -20550,7 +18283,7 @@ paths: 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" @@ -20635,6 +18368,11 @@ paths: 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: @@ -20835,7 +18573,7 @@ paths: 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" @@ -20908,6 +18646,11 @@ paths: 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: @@ -21078,7 +18821,7 @@ paths: 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" @@ -21139,6 +18882,11 @@ paths: 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: @@ -21279,7 +19027,7 @@ paths: 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" @@ -21327,6 +19075,12 @@ paths: $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: @@ -21437,16 +19191,6 @@ paths: 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 @@ -21537,7 +19281,7 @@ paths: 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" @@ -21604,16 +19348,6 @@ paths: 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: @@ -21688,16 +19422,6 @@ paths: 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 @@ -21764,7 +19488,7 @@ paths: 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" @@ -21812,6 +19536,22 @@ paths: $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: @@ -22147,58 +19887,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -22311,7 +19999,7 @@ paths: 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" @@ -22508,58 +20196,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -22672,7 +20308,7 @@ paths: 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" @@ -22767,42 +20403,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -22903,7 +20503,7 @@ paths: 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" @@ -22986,29 +20586,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -23136,51 +20727,6 @@ paths: 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 @@ -23281,7 +20827,7 @@ paths: 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" @@ -23364,29 +20910,29 @@ paths: 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: @@ -23586,47 +21132,6 @@ paths: 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 @@ -23727,7 +21232,7 @@ paths: 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" @@ -23900,47 +21405,6 @@ paths: 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 @@ -24041,7 +21505,7 @@ paths: 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" @@ -24124,31 +21588,6 @@ paths: 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 @@ -24237,7 +21676,7 @@ paths: 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" @@ -24308,14 +21747,24 @@ paths: 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}: @@ -24347,16 +21796,6 @@ paths: 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 @@ -24433,7 +21872,7 @@ paths: 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" @@ -24492,9 +21931,14 @@ paths: 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: @@ -24784,63 +22228,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -24953,7 +22340,7 @@ paths: 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" @@ -25150,63 +22537,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -25319,7 +22649,7 @@ paths: 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" @@ -25414,47 +22744,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -25555,7 +22844,7 @@ paths: 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" @@ -25638,34 +22927,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -25793,56 +23068,6 @@ paths: 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 @@ -25943,7 +23168,7 @@ paths: 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" @@ -26026,34 +23251,29 @@ paths: 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: @@ -26253,52 +23473,6 @@ paths: 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 @@ -26399,7 +23573,7 @@ paths: 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" @@ -26572,162 +23746,116 @@ paths: 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/v10/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/v10/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 @@ -26801,36 +23929,6 @@ paths: 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 @@ -26919,7 +24017,7 @@ paths: 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" @@ -26990,19 +24088,24 @@ paths: 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}: @@ -27034,21 +24137,6 @@ paths: 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 @@ -27125,7 +24213,7 @@ paths: 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" @@ -27184,9 +24272,19 @@ paths: 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}: @@ -27212,11 +24310,6 @@ paths: 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 @@ -27281,7 +24374,7 @@ paths: 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" @@ -27328,6 +24421,17 @@ paths: $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: @@ -27468,7 +24572,7 @@ paths: 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" @@ -27516,6 +24620,12 @@ paths: $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: @@ -27629,61 +24739,6 @@ paths: 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 @@ -27776,7 +24831,7 @@ paths: 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" @@ -27850,61 +24905,12 @@ paths: 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: @@ -27997,61 +25003,6 @@ paths: 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 @@ -28130,7 +25081,7 @@ paths: 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" @@ -28191,44 +25142,24 @@ paths: 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: @@ -28341,46 +25272,6 @@ paths: 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 @@ -28471,7 +25362,7 @@ paths: 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" @@ -28538,44 +25429,14 @@ paths: 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: @@ -28688,46 +25549,6 @@ paths: 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 @@ -28818,7 +25639,7 @@ paths: 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" @@ -28885,44 +25706,14 @@ paths: 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: @@ -28999,46 +25790,6 @@ paths: 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 @@ -29105,7 +25856,7 @@ paths: 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" @@ -29153,6 +25904,52 @@ paths: $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: @@ -29227,39 +26024,6 @@ paths: required: true type: string example: __VNFC-NAME__ - - name: vnfc-function-code - in: query - description: function code - required: false - type: string - - name: vnfc-type - in: query - description: type - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string put: tags: - Network @@ -29326,7 +26090,7 @@ paths: 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" @@ -29374,6 +26138,47 @@ paths: $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: query + description: + required: false + type: string + - name: vnfc-function-code + in: query + description: + required: false + type: string + - name: vnfc-type + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: group-notation + in: query + description: + required: false + type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: put: tags: @@ -29466,56 +26271,6 @@ paths: 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 @@ -29594,7 +26349,7 @@ paths: 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" @@ -29655,49 +26410,14 @@ paths: 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: @@ -29795,51 +26515,6 @@ paths: 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 @@ -29920,7 +26595,7 @@ paths: 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" @@ -29982,51 +26657,12 @@ paths: 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: @@ -30119,51 +26755,6 @@ paths: 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 @@ -30242,7 +26833,7 @@ paths: 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" @@ -30303,49 +26894,9 @@ paths: 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: @@ -30422,51 +26973,6 @@ paths: 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 @@ -30533,7 +27039,7 @@ paths: 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" @@ -30581,6 +27087,57 @@ paths: $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: @@ -30655,11 +27212,6 @@ paths: 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 @@ -30726,7 +27278,7 @@ paths: 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" @@ -30774,6 +27326,17 @@ paths: $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: @@ -31026,131 +27589,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -31253,7 +27691,7 @@ paths: 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" @@ -31403,231 +27841,106 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -31657,7 +27970,7 @@ paths: 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" @@ -31742,115 +28055,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -31941,7 +28145,7 @@ paths: 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" @@ -32014,102 +28218,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -32222,124 +28344,6 @@ paths: 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 @@ -32430,7 +28434,7 @@ paths: 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" @@ -32503,102 +28507,29 @@ paths: 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: @@ -32773,120 +28704,6 @@ paths: 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 @@ -32977,7 +28794,7 @@ paths: 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" @@ -33130,120 +28947,6 @@ paths: 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 @@ -33334,7 +29037,7 @@ paths: 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" @@ -33407,104 +29110,6 @@ paths: 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 @@ -33583,7 +29188,7 @@ paths: 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" @@ -33644,87 +29249,24 @@ paths: 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: @@ -34021,141 +29563,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -34270,7 +29677,7 @@ paths: 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" @@ -34447,165 +29854,30 @@ paths: required: true type: string example: __VNF-ID__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + - 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: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -34720,7 +29992,7 @@ paths: 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" @@ -34817,125 +30089,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -35038,7 +30191,7 @@ paths: 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" @@ -35123,112 +30276,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -35359,134 +30420,6 @@ paths: 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 @@ -35589,7 +30522,7 @@ paths: 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" @@ -35674,112 +30607,29 @@ paths: 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: @@ -35968,146 +30818,22 @@ paths: example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - 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 + description: Name that identifies the link aggregate 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: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network @@ -36210,7 +30936,7 @@ paths: 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" @@ -36387,130 +31113,6 @@ paths: 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 @@ -36613,7 +31215,7 @@ paths: 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" @@ -36698,114 +31300,6 @@ paths: 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 @@ -36896,7 +31390,7 @@ paths: 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" @@ -36969,97 +31463,24 @@ paths: 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}: @@ -37092,99 +31513,6 @@ paths: 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 @@ -37263,7 +31591,7 @@ paths: 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" @@ -37324,87 +31652,19 @@ paths: 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: @@ -37499,124 +31759,6 @@ paths: 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 @@ -37695,7 +31837,7 @@ paths: 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" @@ -37756,87 +31898,44 @@ paths: 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: @@ -37949,89 +32048,6 @@ paths: 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 @@ -38122,7 +32138,7 @@ paths: 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" @@ -38189,87 +32205,14 @@ paths: 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: @@ -38382,89 +32325,6 @@ paths: 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 @@ -38555,7 +32415,7 @@ paths: 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" @@ -38622,87 +32482,14 @@ paths: 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}: @@ -38729,89 +32516,6 @@ paths: 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 @@ -38878,7 +32582,7 @@ paths: 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" @@ -38926,6 +32630,97 @@ paths: $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: @@ -39066,7 +32861,7 @@ paths: 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" @@ -39114,6 +32909,12 @@ paths: $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: @@ -39366,73 +33167,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39535,7 +33269,7 @@ paths: 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" @@ -39712,73 +33446,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39881,7 +33548,7 @@ paths: 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" @@ -39966,57 +33633,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -40107,7 +33723,7 @@ paths: 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" @@ -40180,44 +33796,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -40254,142 +33846,82 @@ paths: 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/v10/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/v10/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 @@ -40480,7 +34012,7 @@ paths: 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" @@ -40553,44 +34085,29 @@ paths: 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: @@ -40765,62 +34282,6 @@ paths: 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 @@ -40911,7 +34372,7 @@ paths: 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" @@ -41064,62 +34525,6 @@ paths: 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 @@ -41210,7 +34615,7 @@ paths: 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" @@ -41283,46 +34688,6 @@ paths: 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 @@ -41401,7 +34766,7 @@ paths: 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" @@ -41462,29 +34827,24 @@ paths: 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}: @@ -41511,31 +34871,6 @@ paths: 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 @@ -41602,7 +34937,7 @@ paths: 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" @@ -41650,6 +34985,37 @@ paths: $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: @@ -41994,58 +35360,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -42160,7 +35474,7 @@ paths: 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" @@ -42361,58 +35675,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -42527,7 +35789,7 @@ paths: 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" @@ -42624,42 +35886,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -42762,7 +35988,7 @@ paths: 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" @@ -42847,29 +36073,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -43000,51 +36217,6 @@ paths: 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 @@ -43147,7 +36319,7 @@ paths: 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" @@ -43186,75 +36358,75 @@ paths: type: string example: __INTERFACE-NAME__ - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - example: __PCI-ID__ - - name: resource-version + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: resource-version for concurrency - required: true - type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: - tags: - - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/sriov-vfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: inv-status - 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: @@ -43459,47 +36631,6 @@ paths: 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 @@ -43602,7 +36733,7 @@ paths: 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" @@ -43779,47 +36910,6 @@ paths: 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 @@ -43922,7 +37012,7 @@ paths: 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" @@ -44007,31 +37097,6 @@ paths: 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 @@ -44122,7 +37187,7 @@ paths: 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" @@ -44195,14 +37260,24 @@ paths: 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: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -44235,16 +37310,6 @@ paths: 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 @@ -44323,7 +37388,7 @@ paths: 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" @@ -44384,9 +37449,14 @@ paths: 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: @@ -44683,63 +37753,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -44854,7 +37867,7 @@ paths: 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" @@ -45007,111 +38020,54 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: 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 + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -45226,7 +38182,7 @@ paths: 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" @@ -45323,47 +38279,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -45466,7 +38381,7 @@ paths: 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" @@ -45551,34 +38466,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -45709,56 +38610,6 @@ paths: 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 - 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 @@ -45861,7 +38712,7 @@ paths: 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" @@ -45946,34 +38797,29 @@ paths: 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: @@ -46178,52 +39024,6 @@ paths: 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 @@ -46326,7 +39126,7 @@ paths: 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" @@ -46503,52 +39303,6 @@ paths: 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 @@ -46651,7 +39405,7 @@ paths: 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" @@ -46736,36 +39490,6 @@ paths: 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 @@ -46856,7 +39580,7 @@ paths: 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" @@ -46929,19 +39653,24 @@ paths: 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: + 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: @@ -46974,21 +39703,6 @@ paths: 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 @@ -47067,7 +39781,7 @@ paths: 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" @@ -47128,9 +39842,19 @@ paths: 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: + required: false + type: string + - name: interface-role in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -47157,11 +39881,6 @@ paths: 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 @@ -47228,7 +39947,7 @@ paths: 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" @@ -47276,6 +39995,17 @@ paths: $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: @@ -47350,11 +40080,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -47421,7 +40146,7 @@ paths: 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" @@ -47469,6 +40194,17 @@ paths: $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: @@ -47689,7 +40425,7 @@ paths: 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" @@ -47750,6 +40486,11 @@ paths: 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: @@ -47840,7 +40581,7 @@ paths: 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" @@ -47888,6 +40629,12 @@ paths: $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: @@ -47962,11 +40709,6 @@ paths: 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 @@ -48033,7 +40775,7 @@ paths: 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" @@ -48081,6 +40823,17 @@ paths: $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: @@ -48155,21 +40908,6 @@ paths: 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 @@ -48236,7 +40974,7 @@ paths: 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" @@ -48284,6 +41022,27 @@ paths: $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: @@ -48358,16 +41117,6 @@ paths: 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 @@ -48434,7 +41183,7 @@ paths: 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" @@ -48482,13 +41231,23 @@ paths: $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 definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -48517,15 +41276,17 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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 network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -48582,15 +41343,18 @@ definitions: 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 @@ -48642,7 +41406,9 @@ definitions: 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: @@ -48698,22 +41464,24 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -48795,19 +41563,21 @@ definitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -48877,13 +41647,15 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -48949,10 +41721,11 @@ definitions: 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: @@ -48997,10 +41770,12 @@ definitions: 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 @@ -49031,8 +41806,10 @@ definitions: 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: @@ -49057,9 +41834,11 @@ definitions: 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 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 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 @@ -49094,8 +41873,9 @@ definitions: 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 @@ -49154,8 +41934,9 @@ definitions: 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 @@ -49231,9 +42012,11 @@ definitions: 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 @@ -49264,8 +42047,10 @@ definitions: 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 @@ -49295,8 +42080,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -49322,10 +42108,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -49408,9 +42196,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -49442,8 +42231,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -49475,7 +42265,9 @@ definitions: 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: @@ -49565,9 +42357,11 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -49626,12 +42420,14 @@ definitions: 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: @@ -49653,7 +42449,9 @@ definitions: 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: @@ -49695,11 +42493,13 @@ definitions: 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 @@ -49734,28 +42534,29 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -49840,8 +42641,10 @@ definitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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. @@ -49938,9 +42741,10 @@ definitions: 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 @@ -49976,7 +42780,9 @@ definitions: 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 @@ -50019,10 +42825,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -50054,7 +42861,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -50075,11 +42884,13 @@ definitions: 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 @@ -50152,14 +42963,15 @@ definitions: 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 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) + - 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 l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -50212,13 +43024,9 @@ definitions: 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: @@ -50263,9 +43071,10 @@ definitions: 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: @@ -50359,21 +43168,23 @@ definitions: 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -50408,11 +43219,13 @@ definitions: 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) vlans: type: array items: @@ -50449,11 +43262,13 @@ definitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -50492,11 +43307,13 @@ definitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -50535,22 +43352,23 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -50579,6 +43397,7 @@ definitions: 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 @@ -50624,10 +43443,13 @@ definitions: 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. @@ -50661,16 +43483,18 @@ definitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -50701,6 +43525,7 @@ definitions: 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: @@ -50721,8 +43546,10 @@ definitions: 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: @@ -50748,8 +43575,10 @@ definitions: 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 @@ -50779,7 +43608,8 @@ definitions: 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: @@ -50805,20 +43635,22 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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 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) + - 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 required: - link-name - link-type @@ -50904,10 +43736,12 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -50923,13 +43757,15 @@ definitions: 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 @@ -50972,9 +43808,11 @@ definitions: 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 @@ -51000,14 +43838,16 @@ definitions: 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 @@ -51050,12 +43890,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -51105,7 +43948,8 @@ definitions: 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 @@ -51145,10 +43989,11 @@ definitions: 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 @@ -51178,13 +44023,15 @@ definitions: 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: @@ -51305,8 +44152,9 @@ definitions: 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: @@ -51330,7 +44178,8 @@ definitions: 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: @@ -51359,8 +44208,9 @@ definitions: 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 @@ -51424,6 +44274,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -51479,9 +44335,10 @@ definitions: 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 @@ -51523,8 +44380,9 @@ definitions: 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 @@ -51619,7 +44477,8 @@ definitions: 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 @@ -51641,15 +44500,17 @@ definitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(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 @@ -51683,6 +44544,7 @@ definitions: 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) relationship-list: type: array items: @@ -51703,7 +44565,9 @@ definitions: 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: @@ -51747,7 +44611,8 @@ definitions: 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: @@ -51773,14 +44638,15 @@ definitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -51817,6 +44683,7 @@ definitions: 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. @@ -51874,9 +44741,11 @@ definitions: 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 @@ -51932,7 +44801,8 @@ definitions: 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: @@ -51966,7 +44836,9 @@ definitions: 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 @@ -51993,19 +44865,20 @@ definitions: 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 @@ -52075,6 +44948,7 @@ definitions: 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. @@ -52121,7 +44995,9 @@ definitions: 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 @@ -52229,7 +45105,8 @@ definitions: 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 @@ -52259,7 +45136,9 @@ definitions: 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 @@ -52288,9 +45167,11 @@ definitions: 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: @@ -52371,7 +45252,9 @@ definitions: 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: @@ -52431,9 +45314,11 @@ definitions: 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 @@ -52479,24 +45364,26 @@ definitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -52575,10 +45462,12 @@ definitions: 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: @@ -52618,9 +45507,11 @@ definitions: 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: @@ -52657,9 +45548,10 @@ definitions: 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: @@ -52697,8 +45589,9 @@ definitions: 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: @@ -52751,8 +45644,10 @@ definitions: 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: @@ -52778,7 +45673,9 @@ definitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -52845,10 +45742,13 @@ definitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -52879,6 +45779,7 @@ definitions: 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 @@ -52908,13 +45809,15 @@ definitions: 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 @@ -52948,7 +45851,9 @@ definitions: 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 - bandwidth-up-wan1 @@ -53014,14 +45919,15 @@ definitions: 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 @@ -53112,12 +46018,15 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -53136,6 +46045,7 @@ definitions: 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. @@ -53183,7 +46093,9 @@ definitions: 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: @@ -53213,10 +46125,11 @@ definitions: 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: @@ -53255,10 +46168,11 @@ definitions: 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: @@ -53297,9 +46211,10 @@ definitions: 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 @@ -53329,15 +46244,17 @@ definitions: 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 @@ -53376,6 +46293,7 @@ definitions: 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) relationship-list: type: array items: @@ -53407,8 +46325,10 @@ definitions: 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 @@ -53447,9 +46367,11 @@ definitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -53477,8 +46399,10 @@ definitions: 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 @@ -53501,7 +46425,9 @@ definitions: 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 @@ -53523,11 +46449,12 @@ definitions: 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 @@ -53581,11 +46508,12 @@ definitions: 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: @@ -53631,11 +46559,13 @@ definitions: description: | VPN binding ###### Related Nodes - - 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 L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - 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 L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -53677,19 +46607,20 @@ definitions: 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 @@ -53714,8 +46645,10 @@ definitions: 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. @@ -53743,10 +46676,11 @@ definitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -53784,12 +46718,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -53818,15 +46746,17 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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 network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -53860,15 +46790,18 @@ patchDefinitions: 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 @@ -53913,7 +46846,9 @@ patchDefinitions: 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: @@ -53962,22 +46897,24 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -54016,19 +46953,21 @@ patchDefinitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -54062,13 +47001,15 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -54123,10 +47064,11 @@ patchDefinitions: 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: @@ -54145,10 +47087,12 @@ patchDefinitions: 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 @@ -54169,8 +47113,10 @@ patchDefinitions: 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: @@ -54188,9 +47134,11 @@ patchDefinitions: 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 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 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 @@ -54218,8 +47166,9 @@ patchDefinitions: 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 @@ -54260,8 +47209,9 @@ patchDefinitions: 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 @@ -54330,9 +47280,11 @@ patchDefinitions: 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 @@ -54353,8 +47305,10 @@ patchDefinitions: 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 @@ -54377,8 +47331,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -54395,10 +47350,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -54474,9 +47431,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -54499,8 +47457,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -54523,7 +47482,9 @@ patchDefinitions: 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: @@ -54606,9 +47567,11 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -54660,12 +47623,14 @@ patchDefinitions: 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: @@ -54680,7 +47645,9 @@ patchDefinitions: 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: @@ -54715,11 +47682,13 @@ patchDefinitions: 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 @@ -54740,28 +47709,29 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -54846,8 +47816,10 @@ patchDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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 @@ -54860,9 +47832,10 @@ patchDefinitions: 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 @@ -54891,7 +47864,9 @@ patchDefinitions: 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 @@ -54927,10 +47902,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -54951,7 +47927,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -54965,11 +47943,13 @@ patchDefinitions: 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 @@ -55031,14 +48011,15 @@ patchDefinitions: 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 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) + - 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 l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -55084,13 +48065,9 @@ patchDefinitions: 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: @@ -55135,9 +48112,10 @@ patchDefinitions: 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: @@ -55220,21 +48198,23 @@ patchDefinitions: 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -55269,6 +48249,7 @@ patchDefinitions: 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. @@ -55281,11 +48262,13 @@ patchDefinitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -55311,11 +48294,13 @@ patchDefinitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -55341,22 +48326,23 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -55385,6 +48371,7 @@ patchDefinitions: 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 @@ -55402,16 +48389,18 @@ patchDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -55434,8 +48423,10 @@ patchDefinitions: 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: @@ -55454,8 +48445,10 @@ patchDefinitions: 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 @@ -55478,7 +48471,8 @@ patchDefinitions: 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: @@ -55497,20 +48491,22 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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 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) + - 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 required: - link-name - link-type @@ -55553,10 +48549,12 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -55569,13 +48567,15 @@ patchDefinitions: 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 @@ -55607,9 +48607,11 @@ patchDefinitions: 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 @@ -55632,14 +48634,16 @@ patchDefinitions: 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 @@ -55665,12 +48669,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -55705,7 +48712,8 @@ patchDefinitions: 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 @@ -55738,10 +48746,11 @@ patchDefinitions: 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 @@ -55761,13 +48770,15 @@ patchDefinitions: 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: @@ -55866,8 +48877,9 @@ patchDefinitions: 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: @@ -55884,7 +48896,8 @@ patchDefinitions: 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: @@ -55906,8 +48919,9 @@ patchDefinitions: 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 @@ -55948,6 +48962,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -56003,9 +49023,10 @@ patchDefinitions: 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 @@ -56040,8 +49061,9 @@ patchDefinitions: 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 @@ -56120,7 +49142,8 @@ patchDefinitions: 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 @@ -56135,15 +49158,17 @@ patchDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(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 @@ -56184,7 +49209,9 @@ patchDefinitions: 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: @@ -56221,7 +49248,8 @@ patchDefinitions: 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: @@ -56240,14 +49268,15 @@ patchDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -56284,6 +49313,7 @@ patchDefinitions: 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. @@ -56320,9 +49350,11 @@ patchDefinitions: 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 @@ -56349,7 +49381,8 @@ patchDefinitions: 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: @@ -56376,7 +49409,9 @@ patchDefinitions: 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 @@ -56401,19 +49436,20 @@ patchDefinitions: 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 @@ -56483,6 +49519,7 @@ patchDefinitions: 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. @@ -56505,7 +49542,9 @@ patchDefinitions: 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 @@ -56605,7 +49644,8 @@ patchDefinitions: 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 @@ -56628,7 +49668,9 @@ patchDefinitions: 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 @@ -56650,9 +49692,11 @@ patchDefinitions: 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: @@ -56722,7 +49766,9 @@ patchDefinitions: 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: @@ -56765,9 +49811,11 @@ patchDefinitions: 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 @@ -56806,24 +49854,26 @@ patchDefinitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -56881,10 +49931,12 @@ patchDefinitions: 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: @@ -56913,9 +49965,11 @@ patchDefinitions: 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: @@ -56941,9 +49995,10 @@ patchDefinitions: 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: @@ -56970,8 +50025,9 @@ patchDefinitions: 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: @@ -57017,8 +50073,10 @@ patchDefinitions: 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: @@ -57037,7 +50095,9 @@ patchDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -57094,10 +50154,13 @@ patchDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -57128,6 +50191,7 @@ patchDefinitions: 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 @@ -57150,13 +50214,15 @@ patchDefinitions: 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 @@ -57179,7 +50245,9 @@ patchDefinitions: 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 - bandwidth-up-wan1 @@ -57238,14 +50306,15 @@ patchDefinitions: 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 @@ -57311,12 +50380,15 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -57335,6 +50407,7 @@ patchDefinitions: 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 @@ -57347,7 +50420,9 @@ patchDefinitions: 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: @@ -57370,10 +50445,11 @@ patchDefinitions: 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: @@ -57399,10 +50475,11 @@ patchDefinitions: 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: @@ -57428,9 +50505,10 @@ patchDefinitions: 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 @@ -57453,15 +50531,17 @@ patchDefinitions: 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 @@ -57496,8 +50576,10 @@ patchDefinitions: 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 @@ -57529,9 +50611,11 @@ patchDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -57559,8 +50643,10 @@ patchDefinitions: 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 @@ -57576,7 +50662,9 @@ patchDefinitions: 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 @@ -57591,11 +50679,12 @@ patchDefinitions: 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 @@ -57642,11 +50731,12 @@ patchDefinitions: 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: @@ -57677,11 +50767,13 @@ patchDefinitions: description: | VPN binding ###### Related Nodes - - 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 L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - 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 L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -57711,19 +50803,20 @@ patchDefinitions: 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 @@ -57748,8 +50841,10 @@ patchDefinitions: 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. @@ -57762,10 +50857,11 @@ patchDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -57796,12 +50892,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -57830,15 +50920,17 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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 network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -57895,15 +50987,18 @@ getDefinitions: 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 @@ -57955,7 +51050,9 @@ getDefinitions: 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: @@ -58011,22 +51108,24 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -58108,19 +51207,21 @@ getDefinitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -58190,13 +51291,15 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -58262,10 +51365,11 @@ getDefinitions: 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: @@ -58310,10 +51414,12 @@ getDefinitions: 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 @@ -58344,8 +51450,10 @@ getDefinitions: 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: @@ -58370,9 +51478,11 @@ getDefinitions: 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 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 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 @@ -58407,8 +51517,9 @@ getDefinitions: 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 @@ -58467,8 +51578,9 @@ getDefinitions: 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 @@ -58544,9 +51656,11 @@ getDefinitions: 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 @@ -58577,8 +51691,10 @@ getDefinitions: 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 @@ -58608,8 +51724,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -58635,10 +51752,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -58721,9 +51840,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -58755,8 +51875,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -58788,7 +51909,9 @@ getDefinitions: 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: @@ -58878,9 +52001,11 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -58939,12 +52064,14 @@ getDefinitions: 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: @@ -58966,7 +52093,9 @@ getDefinitions: 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: @@ -59008,11 +52137,13 @@ getDefinitions: 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 @@ -59047,28 +52178,29 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -59153,8 +52285,10 @@ getDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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. @@ -59251,9 +52385,10 @@ getDefinitions: 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 @@ -59289,7 +52424,9 @@ getDefinitions: 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 @@ -59332,10 +52469,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -59367,7 +52505,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -59388,11 +52528,13 @@ getDefinitions: 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 @@ -59465,14 +52607,15 @@ getDefinitions: 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 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) + - 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 l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -59525,13 +52668,9 @@ getDefinitions: 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: @@ -59576,9 +52715,10 @@ getDefinitions: 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: @@ -59672,21 +52812,23 @@ getDefinitions: 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -59721,11 +52863,13 @@ getDefinitions: 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) vlans: type: array items: @@ -59762,11 +52906,13 @@ getDefinitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -59805,11 +52951,13 @@ getDefinitions: 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 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) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -59848,22 +52996,23 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -59892,6 +53041,7 @@ getDefinitions: 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 @@ -59937,10 +53087,13 @@ getDefinitions: 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. @@ -59974,16 +53127,18 @@ getDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -60014,6 +53169,7 @@ getDefinitions: 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: @@ -60034,8 +53190,10 @@ getDefinitions: 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: @@ -60061,8 +53219,10 @@ getDefinitions: 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 @@ -60092,7 +53252,8 @@ getDefinitions: 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: @@ -60118,20 +53279,22 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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 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) + - 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 required: - link-name - link-type @@ -60217,10 +53380,12 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -60236,13 +53401,15 @@ getDefinitions: 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 @@ -60285,9 +53452,11 @@ getDefinitions: 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 @@ -60313,14 +53482,16 @@ getDefinitions: 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 @@ -60363,12 +53534,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -60418,7 +53592,8 @@ getDefinitions: 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 @@ -60458,10 +53633,11 @@ getDefinitions: 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 @@ -60491,13 +53667,15 @@ getDefinitions: 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: @@ -60618,8 +53796,9 @@ getDefinitions: 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: @@ -60643,7 +53822,8 @@ getDefinitions: 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: @@ -60672,8 +53852,9 @@ getDefinitions: 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 @@ -60737,6 +53918,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -60792,9 +53979,10 @@ getDefinitions: 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 @@ -60836,8 +54024,9 @@ getDefinitions: 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 @@ -60932,7 +54121,8 @@ getDefinitions: 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 @@ -60954,15 +54144,17 @@ getDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(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 @@ -60996,6 +54188,7 @@ getDefinitions: 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) relationship-list: type: array items: @@ -61016,7 +54209,9 @@ getDefinitions: 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: @@ -61060,7 +54255,8 @@ getDefinitions: 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: @@ -61086,14 +54282,15 @@ getDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -61130,6 +54327,7 @@ getDefinitions: 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. @@ -61187,9 +54385,11 @@ getDefinitions: 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 @@ -61245,7 +54445,8 @@ getDefinitions: 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: @@ -61279,7 +54480,9 @@ getDefinitions: 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 @@ -61306,19 +54509,20 @@ getDefinitions: 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 @@ -61388,6 +54592,7 @@ getDefinitions: 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. @@ -61434,7 +54639,9 @@ getDefinitions: 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 @@ -61546,7 +54753,8 @@ getDefinitions: 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 @@ -61576,7 +54784,9 @@ getDefinitions: 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 @@ -61605,9 +54815,11 @@ getDefinitions: 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: @@ -61688,7 +54900,9 @@ getDefinitions: 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: @@ -61748,9 +54962,11 @@ getDefinitions: 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 @@ -61796,24 +55012,26 @@ getDefinitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -61892,10 +55110,12 @@ getDefinitions: 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: @@ -61935,9 +55155,11 @@ getDefinitions: 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: @@ -61974,9 +55196,10 @@ getDefinitions: 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: @@ -62014,8 +55237,9 @@ getDefinitions: 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: @@ -62068,8 +55292,10 @@ getDefinitions: 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: @@ -62095,7 +55321,9 @@ getDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -62162,10 +55390,13 @@ getDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -62196,6 +55427,7 @@ getDefinitions: 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 @@ -62225,13 +55457,15 @@ getDefinitions: 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 @@ -62265,7 +55499,9 @@ getDefinitions: 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 - bandwidth-up-wan1 @@ -62331,14 +55567,15 @@ getDefinitions: 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 @@ -62429,12 +55666,15 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -62453,6 +55693,7 @@ getDefinitions: 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. @@ -62500,7 +55741,9 @@ getDefinitions: 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: @@ -62530,10 +55773,11 @@ getDefinitions: 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: @@ -62572,10 +55816,11 @@ getDefinitions: 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: @@ -62614,9 +55859,10 @@ getDefinitions: 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 @@ -62646,15 +55892,17 @@ getDefinitions: 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 @@ -62693,6 +55941,7 @@ getDefinitions: 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) relationship-list: type: array items: @@ -62724,8 +55973,10 @@ getDefinitions: 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 @@ -62764,9 +56015,11 @@ getDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -62794,8 +56047,10 @@ getDefinitions: 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 @@ -62818,7 +56073,9 @@ getDefinitions: 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 @@ -62840,11 +56097,12 @@ getDefinitions: 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 @@ -62898,11 +56156,12 @@ getDefinitions: 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: @@ -62948,11 +56207,13 @@ getDefinitions: description: | VPN binding ###### Related Nodes - - 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 L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - 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 L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -62994,19 +56255,20 @@ getDefinitions: 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 @@ -63031,8 +56293,10 @@ getDefinitions: 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. @@ -63060,10 +56324,11 @@ getDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml index 10d06268..e34cbab8 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 @@ -756,7 +712,7 @@ paths: 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" @@ -829,214 +785,32 @@ paths: 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/v11/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 @@ -1079,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: - $ref: "#/definitions/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 @@ -1140,25 +903,21 @@ paths: 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: @@ -1192,26 +951,22 @@ paths: 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: @@ -1239,55 +994,35 @@ paths: 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/v11/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 @@ -1322,18 +1057,24 @@ paths: 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/v11/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 @@ -1368,19 +1109,32 @@ paths: 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: @@ -1408,21 +1162,54 @@ paths: 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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1431,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1466,24 +1253,12 @@ paths: 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 @@ -1530,15 +1305,9 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1547,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1594,27 +1363,19 @@ paths: 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: @@ -1660,91 +1421,130 @@ paths: 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/v11/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 @@ -1883,7 +1683,7 @@ paths: 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" @@ -2132,91 +1932,6 @@ paths: 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 @@ -2355,7 +2070,7 @@ paths: 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" @@ -2476,75 +2191,6 @@ paths: 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 @@ -2671,7 +2317,7 @@ paths: 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" @@ -2780,62 +2426,20 @@ paths: 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: @@ -3002,84 +2606,6 @@ paths: 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 @@ -3206,7 +2732,7 @@ paths: 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" @@ -3315,62 +2841,29 @@ paths: 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: @@ -3635,80 +3128,6 @@ paths: 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 @@ -3835,7 +3254,7 @@ paths: 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" @@ -4060,80 +3479,6 @@ paths: 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 @@ -4260,7 +3605,7 @@ paths: 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" @@ -4369,64 +3714,6 @@ paths: 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 @@ -4541,7 +3828,7 @@ paths: 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" @@ -4638,49 +3925,26 @@ paths: 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: @@ -4723,49 +3987,6 @@ paths: 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 @@ -4868,7 +4089,7 @@ paths: 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" @@ -4953,26 +4174,36 @@ paths: 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: @@ -5083,26 +4314,6 @@ paths: 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 @@ -5193,7 +4404,7 @@ paths: 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" @@ -5266,14 +4477,19 @@ paths: 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}/relationship-list/relationship: @@ -5386,21 +4602,6 @@ paths: 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: Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -5491,7 +4692,7 @@ paths: 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" @@ -5564,14 +4765,14 @@ paths: 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: @@ -5684,26 +4885,6 @@ paths: 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 @@ -5794,7 +4975,7 @@ paths: 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" @@ -5867,14 +5048,19 @@ paths: 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: @@ -5987,41 +5173,6 @@ paths: 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 @@ -6112,7 +5263,7 @@ paths: 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" @@ -6185,14 +5336,34 @@ paths: 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: @@ -6310,36 +5481,6 @@ paths: 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 @@ -6440,7 +5581,7 @@ paths: 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" @@ -6524,34 +5665,9 @@ paths: 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}: @@ -6590,36 +5706,6 @@ paths: 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 @@ -6710,7 +5796,7 @@ paths: 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" @@ -6783,14 +5869,29 @@ paths: 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: @@ -6903,21 +6004,6 @@ paths: 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 @@ -7008,7 +6094,7 @@ paths: 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" @@ -7081,14 +6167,14 @@ paths: 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: @@ -7201,27 +6287,6 @@ paths: 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 @@ -7312,7 +6377,7 @@ paths: 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" @@ -7385,16 +6450,22 @@ paths: 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: @@ -7505,16 +6576,6 @@ paths: 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 @@ -7605,7 +6666,7 @@ paths: 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" @@ -7678,14 +6739,9 @@ paths: 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: @@ -7860,205 +6916,190 @@ paths: required: true type: string example: __ESR-SYSTEM-INFO-ID__ - - name: cloud-type + put: + tags: + - CloudInfrastructure + summary: create or update an existing esr-system-info + description: | + Create or update an existing esr-system-info. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - 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: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: body + in: body + description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) + required: true + schema: + $ref: "#/definitions/esr-system-info" + patch: + tags: + - CloudInfrastructure + summary: update an existing esr-system-info + description: | + Update an existing esr-system-info + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml + 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: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: body + in: body + description: esr-system-info object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/esr-system-info" + delete: + tags: + - CloudInfrastructure + summary: delete an existing esr-system-info + description: delete an existing esr-system-info + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "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: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: resource-version in: query - description: Type of the cloud (e.g., openstack) - required: false + description: resource-version for concurrency + required: true type: string - - name: owner-defined-type + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list: + get: + tags: + - CloudInfrastructure + summary: returns esr-system-info-list + description: returns esr-system-info-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/esr-system-info-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 + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - name: system-name in: query - description: name of external system. + description: required: false type: string - name: system-type in: query - description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + description: required: false type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing esr-system-info - description: | - Create or update an existing esr-system-info. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - 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: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-ID__ - - name: body - in: body - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) - required: true - schema: - $ref: "#/definitions/esr-system-info" - patch: - tags: - - CloudInfrastructure - summary: update an existing esr-system-info - description: | - Update an existing esr-system-info - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - application/xml - 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: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-ID__ - - name: body - in: body - description: esr-system-info object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/esr-system-info" - delete: - tags: - - CloudInfrastructure - summary: delete an existing esr-system-info - description: delete an existing esr-system-info - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "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: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-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}/esr-system-info-list: - get: - tags: - - CloudInfrastructure - summary: returns esr-system-info-list - description: returns esr-system-info-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/esr-system-info-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 - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -8163,32 +7204,6 @@ paths: 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 @@ -8279,7 +7294,7 @@ paths: 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" @@ -8432,32 +7447,6 @@ paths: 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 @@ -8548,7 +7537,7 @@ paths: 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" @@ -8621,16 +7610,6 @@ paths: 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 @@ -8709,7 +7688,7 @@ paths: 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" @@ -8763,6 +7742,27 @@ paths: $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: @@ -8903,7 +7903,7 @@ paths: 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" @@ -8951,6 +7951,12 @@ paths: $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: @@ -9173,30 +8179,6 @@ paths: 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 @@ -9287,7 +8269,7 @@ paths: 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" @@ -9360,28 +8342,9 @@ paths: 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: @@ -9616,72 +8579,6 @@ paths: 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 @@ -9796,7 +8693,7 @@ paths: 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" @@ -9997,72 +8894,6 @@ paths: 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 @@ -10177,7 +9008,7 @@ paths: 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" @@ -10274,168 +9105,118 @@ paths: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - 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: pserver-id - in: query - description: ID of Pserver - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: tags: - CloudInfrastructure - summary: create or update an existing vlan - description: | - Create or update an existing vlan. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) - required: true - schema: - $ref: "#/definitions/vlan" - patch: - tags: - - CloudInfrastructure - summary: update an existing vlan - description: | - Update an existing vlan - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vlan" - delete: - tags: - - CloudInfrastructure - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -10511,43 +9292,20 @@ paths: 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: @@ -10678,65 +9436,6 @@ paths: 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: 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: - CloudInfrastructure @@ -10839,7 +9538,7 @@ paths: 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" @@ -10924,43 +9623,29 @@ paths: 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: @@ -11165,61 +9850,6 @@ paths: 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 @@ -11322,7 +9952,7 @@ paths: 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" @@ -11499,61 +10129,6 @@ paths: 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 @@ -11656,7 +10231,7 @@ paths: 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" @@ -11741,45 +10316,6 @@ paths: 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 @@ -11870,7 +10406,7 @@ paths: 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" @@ -11943,28 +10479,24 @@ paths: 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}: @@ -11997,30 +10529,6 @@ paths: 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 @@ -12099,7 +10607,7 @@ paths: 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" @@ -12160,23 +10668,14 @@ paths: 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: @@ -12473,77 +10972,6 @@ paths: 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 @@ -12658,7 +11086,7 @@ paths: 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" @@ -12859,77 +11287,6 @@ paths: 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 @@ -13044,7 +11401,7 @@ paths: 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" @@ -13141,61 +11498,6 @@ paths: 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 @@ -13298,7 +11600,7 @@ paths: 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" @@ -13383,48 +11685,20 @@ paths: 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: @@ -13555,70 +11829,6 @@ paths: 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 @@ -13721,7 +11931,7 @@ paths: 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" @@ -13806,48 +12016,29 @@ paths: 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: @@ -14052,66 +12243,6 @@ paths: 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 @@ -14214,7 +12345,7 @@ paths: 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" @@ -14391,66 +12522,6 @@ paths: 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 @@ -14553,7 +12624,7 @@ paths: 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" @@ -14638,50 +12709,6 @@ paths: 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 @@ -14772,7 +12799,7 @@ paths: 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" @@ -14845,33 +12872,24 @@ paths: 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}: @@ -14904,35 +12922,6 @@ paths: 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 @@ -15011,7 +13000,7 @@ paths: 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" @@ -15072,23 +13061,19 @@ paths: 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}: @@ -15115,25 +13100,6 @@ paths: 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 @@ -15200,7 +13166,7 @@ paths: 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" @@ -15248,6 +13214,32 @@ paths: $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: @@ -15322,11 +13314,6 @@ paths: 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 @@ -15393,7 +13380,7 @@ paths: 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" @@ -15441,6 +13428,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -15520,26 +13518,6 @@ paths: 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 @@ -15616,7 +13594,7 @@ paths: 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" @@ -15676,24 +13654,9 @@ paths: 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}: @@ -15720,26 +13683,6 @@ paths: 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 @@ -15806,7 +13749,7 @@ paths: 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" @@ -15854,6 +13797,32 @@ paths: $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: @@ -15969,171 +13938,116 @@ paths: required: true type: string example: __METANAME__ - - 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 + 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: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - 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-invariant-id - in: query - description: the ASDC model id 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: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + 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: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - 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: __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-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true type: string - put: + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: 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 - 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. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) - required: true - schema: - $ref: "#/definitions/metadatum" - patch: - tags: - - Business - summary: update an existing metadatum - description: | - Update an existing metadatum - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: metaname - in: path - required: true - type: string - example: __METANAME__ - - name: body - in: body - description: metadatum object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/metadatum" - delete: - tags: - - Business - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json - application/xml @@ -16208,59 +14122,9 @@ paths: 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 + - name: metaname 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: @@ -16409,81 +14273,6 @@ paths: 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 @@ -16598,7 +14387,7 @@ paths: 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" @@ -16695,79 +14484,9 @@ paths: 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: @@ -16898,81 +14617,6 @@ paths: 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 @@ -17075,7 +14719,7 @@ paths: 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" @@ -17160,59 +14804,29 @@ paths: 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. - 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. + description: 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}: @@ -17251,61 +14865,6 @@ paths: 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 @@ -17396,7 +14955,7 @@ paths: 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" @@ -17469,14 +15028,54 @@ paths: 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: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -17571,16 +15170,6 @@ paths: 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 @@ -17659,7 +15248,7 @@ paths: 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" @@ -17720,14 +15309,9 @@ paths: 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: @@ -17804,16 +15388,6 @@ paths: 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 @@ -17880,7 +15454,7 @@ paths: 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" @@ -17928,6 +15502,22 @@ paths: $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: @@ -18068,7 +15658,7 @@ paths: 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" @@ -18116,6 +15706,12 @@ paths: $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: @@ -18256,7 +15852,7 @@ paths: 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" @@ -18304,6 +15900,12 @@ paths: $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: @@ -18444,7 +16046,7 @@ paths: 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" @@ -18492,6 +16094,12 @@ paths: $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: @@ -18632,7 +16240,7 @@ paths: 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" @@ -18680,6 +16288,12 @@ paths: $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: @@ -18754,21 +16368,6 @@ paths: 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 @@ -18835,7 +16434,7 @@ paths: 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" @@ -18883,6 +16482,27 @@ paths: $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: @@ -18957,11 +16577,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19028,7 +16643,7 @@ paths: 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" @@ -19076,6 +16691,17 @@ paths: $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: @@ -19246,7 +16872,7 @@ paths: 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" @@ -19300,6 +16926,17 @@ paths: $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: @@ -19452,21 +17089,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -19585,7 +17207,7 @@ paths: 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" @@ -19687,19 +17309,9 @@ paths: 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 + - name: element-choice-set-uuid in: query - description: Version + 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: @@ -19839,21 +17451,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -19962,7 +17559,7 @@ paths: 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" @@ -20054,19 +17651,9 @@ paths: 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 + - name: constrained-element-set-uuid in: query - description: Version + 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}: @@ -20109,21 +17696,6 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20222,7 +17794,7 @@ paths: 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" @@ -20304,19 +17876,9 @@ paths: 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 + - name: model-constraint-uuid in: query - description: Version + 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: @@ -20426,21 +17988,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -20529,7 +18076,7 @@ paths: 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" @@ -20601,19 +18148,9 @@ paths: 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 + - name: model-element-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: @@ -20651,21 +18188,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -20754,7 +18276,7 @@ paths: 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" @@ -20826,19 +18348,9 @@ paths: 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 + - name: metaname in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: @@ -20933,21 +18445,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -21026,7 +18523,7 @@ paths: 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" @@ -21087,9 +18584,19 @@ paths: 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: Type of the model, e.g., service, resource, widget, etc. + description: + required: false + type: string + - name: model-version + in: query + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -21166,11 +18673,6 @@ paths: 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 @@ -21237,7 +18739,7 @@ paths: 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" @@ -21285,6 +18787,17 @@ paths: $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: @@ -21386,10 +18899,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21474,7 +18983,7 @@ paths: 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" @@ -21542,8 +19051,9 @@ paths: 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}: @@ -21579,10 +19089,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21667,7 +19173,7 @@ paths: 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" @@ -21735,8 +19241,9 @@ paths: 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: @@ -21825,10 +19332,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21903,7 +19406,7 @@ paths: 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" @@ -21961,8 +19464,9 @@ paths: 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: @@ -22036,10 +19540,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22104,7 +19604,7 @@ paths: 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" @@ -22151,6 +19651,17 @@ paths: $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: @@ -22225,46 +19736,6 @@ paths: 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 @@ -22331,7 +19802,7 @@ paths: 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" @@ -22379,6 +19850,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: 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: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - 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: @@ -22609,7 +20126,7 @@ paths: 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" @@ -22694,6 +20211,11 @@ paths: 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: @@ -22894,7 +20416,7 @@ paths: 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" @@ -22967,6 +20489,11 @@ paths: 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: @@ -23137,7 +20664,7 @@ paths: 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" @@ -23198,6 +20725,11 @@ paths: 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: @@ -23338,7 +20870,7 @@ paths: 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" @@ -23386,6 +20918,12 @@ paths: $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: @@ -23496,16 +21034,6 @@ paths: 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 @@ -23596,7 +21124,7 @@ paths: 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" @@ -23663,16 +21191,6 @@ paths: 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: @@ -23747,16 +21265,6 @@ paths: 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 @@ -23823,7 +21331,7 @@ paths: 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" @@ -23871,6 +21379,22 @@ paths: $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: @@ -24086,16 +21610,6 @@ paths: 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 @@ -24184,7 +21698,7 @@ paths: 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" @@ -24255,14 +21769,9 @@ paths: 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: @@ -24492,58 +22001,6 @@ paths: 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 @@ -24656,7 +22113,7 @@ paths: 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" @@ -24853,180 +22310,128 @@ paths: 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - 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: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + 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: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - 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: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical 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: interface-name + in: path + description: Name given to the interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -25112,42 +22517,6 @@ paths: 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 @@ -25248,7 +22617,7 @@ paths: 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" @@ -25331,29 +22700,20 @@ paths: 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: @@ -25481,51 +22841,6 @@ paths: 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 @@ -25626,7 +22941,7 @@ paths: 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" @@ -25709,29 +23024,29 @@ paths: 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: @@ -25931,47 +23246,6 @@ paths: 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 @@ -26072,7 +23346,7 @@ paths: 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" @@ -26245,47 +23519,6 @@ paths: 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 @@ -26386,7 +23619,7 @@ paths: 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" @@ -26469,31 +23702,6 @@ paths: 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 @@ -26582,7 +23790,7 @@ paths: 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" @@ -26653,14 +23861,24 @@ paths: 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: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: @@ -26692,16 +23910,6 @@ paths: 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 @@ -26778,7 +23986,7 @@ paths: 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" @@ -26837,9 +24045,14 @@ paths: 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: @@ -27129,63 +24342,6 @@ paths: 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 @@ -27298,7 +24454,7 @@ paths: 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" @@ -27495,63 +24651,6 @@ paths: 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 @@ -27664,7 +24763,7 @@ paths: 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" @@ -27733,190 +24832,149 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - put: - tags: - - Network - summary: create or update an existing vlan - description: | - Create or update an existing vlan. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) - required: true - schema: - $ref: "#/definitions/vlan" - patch: - tags: - - Network - summary: update an existing vlan - description: | - Update an existing vlan - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vlan" - delete: - tags: - - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -27983,34 +25041,20 @@ paths: 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: @@ -28138,56 +25182,6 @@ paths: 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 @@ -28288,7 +25282,7 @@ paths: 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" @@ -28371,34 +25365,29 @@ paths: 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: @@ -28598,52 +25587,6 @@ paths: 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 @@ -28744,7 +25687,7 @@ paths: 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" @@ -28917,52 +25860,6 @@ paths: 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: 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 @@ -29063,7 +25960,7 @@ paths: 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" @@ -29146,36 +26043,6 @@ paths: 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 @@ -29264,7 +26131,7 @@ paths: 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" @@ -29335,19 +26202,24 @@ paths: 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}: @@ -29379,21 +26251,6 @@ paths: 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 @@ -29470,7 +26327,7 @@ paths: 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" @@ -29529,9 +26386,19 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}: @@ -29557,11 +26424,6 @@ paths: 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 @@ -29626,7 +26488,7 @@ paths: 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" @@ -29673,6 +26535,17 @@ paths: $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: @@ -29813,7 +26686,7 @@ paths: 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" @@ -29861,6 +26734,12 @@ paths: $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: @@ -29974,61 +26853,6 @@ paths: 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 @@ -30121,7 +26945,7 @@ paths: 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" @@ -30195,61 +27019,12 @@ paths: 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: @@ -30342,61 +27117,6 @@ paths: 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 @@ -30475,7 +27195,7 @@ paths: 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" @@ -30536,44 +27256,24 @@ paths: 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: @@ -30686,46 +27386,6 @@ paths: 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 @@ -30816,7 +27476,7 @@ paths: 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" @@ -30883,44 +27543,14 @@ paths: 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: @@ -31033,46 +27663,6 @@ paths: 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 @@ -31163,7 +27753,7 @@ paths: 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" @@ -31230,44 +27820,14 @@ paths: 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: @@ -31344,46 +27904,6 @@ paths: 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 @@ -31450,7 +27970,7 @@ paths: 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" @@ -31498,6 +28018,52 @@ paths: $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: @@ -31640,65 +28206,6 @@ paths: 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 @@ -31777,7 +28284,7 @@ paths: 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" @@ -31906,65 +28413,6 @@ paths: 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 @@ -32043,7 +28491,7 @@ paths: 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" @@ -32104,49 +28552,6 @@ paths: 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 @@ -32213,7 +28618,7 @@ paths: 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" @@ -32261,6 +28666,57 @@ paths: $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: @@ -32371,56 +28827,6 @@ paths: 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 @@ -32511,7 +28917,7 @@ paths: 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" @@ -32584,54 +28990,9 @@ paths: 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: @@ -32726,56 +29087,6 @@ paths: 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 @@ -32854,7 +29165,7 @@ paths: 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" @@ -32915,49 +29226,14 @@ paths: 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: @@ -33055,51 +29331,6 @@ paths: 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 @@ -33180,7 +29411,7 @@ paths: 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" @@ -33242,51 +29473,12 @@ paths: 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: @@ -33379,51 +29571,6 @@ paths: 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 @@ -33502,7 +29649,7 @@ paths: 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" @@ -33563,49 +29710,9 @@ paths: 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: @@ -33682,51 +29789,6 @@ paths: 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 @@ -33793,7 +29855,7 @@ paths: 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" @@ -33841,6 +29903,57 @@ paths: $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: @@ -33915,11 +30028,6 @@ paths: 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 @@ -33986,7 +30094,7 @@ paths: 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" @@ -34034,6 +30142,17 @@ paths: $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: @@ -34259,231 +30378,106 @@ paths: 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: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: 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 - 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv4-address-list - description: | - Update an existing l3-interface-ipv4-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -34513,7 +30507,7 @@ paths: 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" @@ -34690,131 +30684,6 @@ paths: 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 @@ -34917,7 +30786,7 @@ paths: 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" @@ -35002,115 +30871,6 @@ paths: 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 @@ -35201,7 +30961,7 @@ paths: 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" @@ -35274,102 +31034,20 @@ paths: 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: @@ -35482,124 +31160,6 @@ paths: 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 @@ -35690,7 +31250,7 @@ paths: 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" @@ -35763,102 +31323,29 @@ paths: 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: @@ -36033,120 +31520,6 @@ paths: 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 @@ -36237,7 +31610,7 @@ paths: 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" @@ -36390,120 +31763,6 @@ paths: 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 @@ -36594,7 +31853,7 @@ paths: 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" @@ -36667,104 +31926,6 @@ paths: 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 @@ -36843,7 +32004,7 @@ paths: 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" @@ -36904,87 +32065,24 @@ paths: 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: @@ -37281,141 +32379,6 @@ paths: 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 @@ -37530,7 +32493,7 @@ paths: 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" @@ -37707,165 +32670,30 @@ paths: required: true type: string example: __VNF-ID__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - 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 + - 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: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -37980,7 +32808,7 @@ paths: 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" @@ -38077,125 +32905,6 @@ paths: 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 @@ -38298,7 +33007,7 @@ paths: 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" @@ -38383,112 +33092,20 @@ paths: 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: @@ -38619,134 +33236,6 @@ paths: 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 @@ -38849,7 +33338,7 @@ paths: 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" @@ -38934,112 +33423,29 @@ paths: 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: @@ -39228,146 +33634,22 @@ paths: example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - 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 + description: Name that identifies the link aggregate 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: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network @@ -39470,7 +33752,7 @@ paths: 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" @@ -39647,130 +33929,6 @@ paths: 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 @@ -39873,7 +34031,7 @@ paths: 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" @@ -39958,114 +34116,6 @@ paths: 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 @@ -40156,7 +34206,7 @@ paths: 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" @@ -40229,97 +34279,24 @@ paths: 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}: @@ -40352,99 +34329,6 @@ paths: 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 @@ -40523,7 +34407,7 @@ paths: 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" @@ -40584,87 +34468,19 @@ paths: 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: @@ -40759,124 +34575,6 @@ paths: 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 @@ -40955,7 +34653,7 @@ paths: 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" @@ -41016,87 +34714,44 @@ paths: 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. - 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 + description: 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: @@ -41209,89 +34864,6 @@ paths: 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 @@ -41382,7 +34954,7 @@ paths: 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" @@ -41449,87 +35021,14 @@ paths: 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: @@ -41642,89 +35141,6 @@ paths: 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 @@ -41815,7 +35231,7 @@ paths: 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" @@ -41882,87 +35298,14 @@ paths: 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}: @@ -41989,203 +35332,211 @@ paths: required: true type: string example: __VNF-ID__ + put: + tags: + - Network + summary: create or update an existing generic-vnf + description: | + Create or update an existing generic-vnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/generic-vnf" + patch: + tags: + - Network + summary: update an existing generic-vnf + description: | + Update an existing generic-vnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/generic-vnf" + delete: + tags: + - Network + summary: delete an existing generic-vnf + description: delete an existing generic-vnf + operationId: deleteNetworkGenericVnfsGenericVnf + consumes: + - 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: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs: + get: + tags: + - Network + summary: returns generic-vnfs + description: returns generic-vnfs + operationId: getNetworkGenericVnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $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: Name of VNF. + description: required: false type: string - name: vnf-name2 in: query - description: Alternate name of VNF. + description: 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. + description: 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 + description: required: false type: string - name: regional-resource-zone in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - name: prov-status 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 + description: required: false type: boolean - name: is-closed-loop-disabled in: query + description: 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 + description: required: false type: string - name: nf-function in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - name: nf-role in: query - description: role in the network that this model will be providing + description: required: false type: string - name: nf-naming-code in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - put: - tags: - - Network - summary: create or update an existing generic-vnf - description: | - Create or update an existing generic-vnf. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: body - in: body - description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) - required: true - schema: - $ref: "#/definitions/generic-vnf" - patch: - tags: - - Network - summary: update an existing generic-vnf - description: | - Update an existing generic-vnf - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: body - in: body - description: generic-vnf object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/generic-vnf" - delete: - tags: - - Network - summary: delete an existing generic-vnf - description: delete an existing generic-vnf - operationId: deleteNetworkGenericVnfsGenericVnf - consumes: - - 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: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/generic-vnfs: - get: - tags: - - Network - summary: returns generic-vnfs - description: returns generic-vnfs - operationId: getNetworkGenericVnfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/generic-vnfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: @@ -42326,7 +35677,7 @@ paths: 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" @@ -42374,6 +35725,12 @@ paths: $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: @@ -42626,73 +35983,6 @@ paths: 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 @@ -42795,7 +36085,7 @@ paths: 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" @@ -42972,73 +36262,6 @@ paths: 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 @@ -43141,7 +36364,7 @@ paths: 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" @@ -43179,104 +36402,53 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - 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 + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-id + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: ID of interface - required: false + description: resource-version for concurrency + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network @@ -43367,7 +36539,7 @@ paths: 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" @@ -43440,44 +36612,20 @@ paths: 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: @@ -43590,66 +36738,6 @@ paths: 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 - 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 @@ -43740,7 +36828,7 @@ paths: 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" @@ -43813,44 +36901,29 @@ paths: 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: @@ -44025,62 +37098,6 @@ paths: 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 @@ -44171,7 +37188,7 @@ paths: 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" @@ -44324,62 +37341,6 @@ paths: 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 @@ -44470,7 +37431,7 @@ paths: 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" @@ -44543,46 +37504,6 @@ paths: 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 @@ -44661,7 +37582,7 @@ paths: 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" @@ -44722,29 +37643,24 @@ paths: 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}: @@ -44771,31 +37687,6 @@ paths: 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 @@ -44862,7 +37753,7 @@ paths: 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" @@ -44910,6 +37801,37 @@ paths: $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: @@ -45132,16 +38054,6 @@ paths: 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 @@ -45232,7 +38144,7 @@ paths: 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" @@ -45305,14 +38217,9 @@ paths: 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: @@ -45547,58 +38454,6 @@ paths: 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 @@ -45713,7 +38568,7 @@ paths: 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" @@ -45914,58 +38769,6 @@ paths: 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 @@ -46080,7 +38883,7 @@ paths: 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" @@ -46177,42 +38980,6 @@ paths: 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 @@ -46315,7 +39082,7 @@ paths: 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" @@ -46400,29 +39167,20 @@ paths: 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: @@ -46553,51 +39311,6 @@ paths: 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 @@ -46700,7 +39413,7 @@ paths: 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" @@ -46785,29 +39498,29 @@ paths: 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: @@ -47012,47 +39725,6 @@ paths: 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 @@ -47155,7 +39827,7 @@ paths: 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" @@ -47332,47 +40004,6 @@ paths: 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 @@ -47475,7 +40106,7 @@ paths: 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" @@ -47560,31 +40191,6 @@ paths: 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 @@ -47675,7 +40281,7 @@ paths: 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" @@ -47748,14 +40354,24 @@ paths: 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: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -47788,16 +40404,6 @@ paths: 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 @@ -47876,7 +40482,7 @@ paths: 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" @@ -47937,9 +40543,14 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status + - name: interface-name + in: query + description: + required: false + type: string + - name: prov-status in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -48236,63 +40847,6 @@ paths: 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 @@ -48407,7 +40961,7 @@ paths: 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" @@ -48608,63 +41162,6 @@ paths: 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 @@ -48779,7 +41276,7 @@ paths: 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" @@ -48823,100 +41320,59 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-role + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + description: resource-version for concurrency + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network @@ -49019,7 +41475,7 @@ paths: 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" @@ -49104,34 +41560,20 @@ paths: 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: @@ -49262,56 +41704,6 @@ paths: 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 - 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 @@ -49414,7 +41806,7 @@ paths: 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" @@ -49499,34 +41891,29 @@ paths: 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: @@ -49731,52 +42118,6 @@ paths: 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 @@ -49879,7 +42220,7 @@ paths: 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" @@ -50056,52 +42397,6 @@ paths: 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 @@ -50204,7 +42499,7 @@ paths: 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" @@ -50289,36 +42584,6 @@ paths: 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 @@ -50409,7 +42674,7 @@ paths: 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" @@ -50482,19 +42747,24 @@ paths: 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}: @@ -50527,21 +42797,6 @@ paths: 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 @@ -50620,7 +42875,7 @@ paths: 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" @@ -50681,9 +42936,19 @@ paths: 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: interface-id + in: query + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -50710,11 +42975,6 @@ paths: 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 @@ -50781,7 +43041,7 @@ paths: 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" @@ -50829,6 +43089,17 @@ paths: $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: @@ -50903,11 +43174,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -50974,7 +43240,7 @@ paths: 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" @@ -51022,6 +43288,17 @@ paths: $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: @@ -51242,7 +43519,7 @@ paths: 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" @@ -51303,6 +43580,11 @@ paths: 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: @@ -51393,7 +43675,7 @@ paths: 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" @@ -51441,6 +43723,12 @@ paths: $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: @@ -51515,11 +43803,6 @@ paths: 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 @@ -51586,7 +43869,7 @@ paths: 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" @@ -51634,6 +43917,17 @@ paths: $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: @@ -51708,21 +44002,6 @@ paths: 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 @@ -51789,7 +44068,7 @@ paths: 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" @@ -51837,6 +44116,27 @@ paths: $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: @@ -51911,16 +44211,6 @@ paths: 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 @@ -51987,7 +44277,7 @@ paths: 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" @@ -52035,6 +44325,22 @@ paths: $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: @@ -52114,16 +44420,6 @@ paths: 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 @@ -52200,7 +44496,7 @@ paths: 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" @@ -52260,14 +44556,9 @@ paths: 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}: @@ -52294,16 +44585,6 @@ paths: 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 @@ -52370,7 +44651,7 @@ paths: 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" @@ -52418,13 +44699,23 @@ paths: $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 definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -52453,20 +44744,23 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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) + - 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: @@ -52523,15 +44817,18 @@ definitions: 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 @@ -52599,7 +44896,9 @@ definitions: 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: @@ -52655,26 +44954,28 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM 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 + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -52706,6 +45007,7 @@ definitions: 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. @@ -52777,20 +45079,22 @@ definitions: 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 @@ -52860,13 +45164,15 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -52932,10 +45238,11 @@ definitions: 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: @@ -52980,10 +45287,12 @@ definitions: 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 @@ -53014,8 +45323,10 @@ definitions: 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: @@ -53040,10 +45351,12 @@ definitions: 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 @@ -53078,8 +45391,9 @@ definitions: 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 @@ -53138,8 +45452,9 @@ definitions: 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 @@ -53213,9 +45528,11 @@ definitions: 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 @@ -53246,8 +45563,10 @@ definitions: 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 @@ -53277,8 +45596,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -53304,10 +45624,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -53390,9 +45712,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -53424,8 +45747,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -53457,7 +45781,9 @@ definitions: 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: @@ -53547,9 +45873,11 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -53608,12 +45936,14 @@ definitions: 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: @@ -53635,7 +45965,9 @@ definitions: 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: @@ -53677,11 +46009,13 @@ definitions: 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 @@ -53716,43 +46050,40 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - 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) + - 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: @@ -53856,8 +46187,10 @@ definitions: 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. @@ -53968,9 +46301,10 @@ definitions: 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 @@ -54006,7 +46340,9 @@ definitions: 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 @@ -54049,10 +46385,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -54084,7 +46421,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -54105,11 +46444,13 @@ definitions: 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 @@ -54182,22 +46523,20 @@ definitions: 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 @@ -54261,13 +46600,9 @@ definitions: 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: @@ -54312,9 +46647,10 @@ definitions: 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: @@ -54408,22 +46744,24 @@ definitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -54459,16 +46797,19 @@ definitions: 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. @@ -54508,12 +46849,14 @@ definitions: 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: @@ -54552,12 +46895,14 @@ definitions: 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: @@ -54596,23 +46941,24 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - 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) + - 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 @@ -54641,6 +46987,7 @@ definitions: 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 @@ -54686,10 +47033,13 @@ definitions: 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. @@ -54723,16 +47073,18 @@ definitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -54763,6 +47115,7 @@ definitions: 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: @@ -54783,8 +47136,10 @@ definitions: 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: @@ -54810,8 +47165,10 @@ definitions: 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 @@ -54841,7 +47198,8 @@ definitions: 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: @@ -54867,21 +47225,23 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - 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) + - 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 required: - link-name - in-maint @@ -54892,6 +47252,7 @@ definitions: 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 @@ -54970,11 +47331,13 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -54990,13 +47353,15 @@ definitions: 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 @@ -55039,9 +47404,11 @@ definitions: 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 @@ -55067,14 +47434,16 @@ definitions: 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 @@ -55117,12 +47486,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -55172,7 +47544,8 @@ definitions: 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 @@ -55212,10 +47585,11 @@ definitions: 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 @@ -55245,13 +47619,15 @@ definitions: 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: @@ -55376,8 +47752,9 @@ definitions: 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: @@ -55401,7 +47778,8 @@ definitions: 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: @@ -55430,8 +47808,9 @@ definitions: 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 @@ -55495,6 +47874,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -55550,9 +47935,10 @@ definitions: 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 @@ -55594,8 +47980,9 @@ definitions: 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 @@ -55690,7 +48077,8 @@ definitions: 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 @@ -55712,16 +48100,18 @@ definitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - 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) + + -(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 @@ -55758,6 +48148,7 @@ definitions: 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 @@ -55785,7 +48176,9 @@ definitions: 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: @@ -55843,7 +48236,8 @@ definitions: 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: @@ -55869,16 +48263,17 @@ definitions: 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) + - 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 has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - 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) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -55915,6 +48310,7 @@ definitions: 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. @@ -55972,9 +48368,11 @@ definitions: 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 @@ -56030,7 +48428,8 @@ definitions: 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: @@ -56064,7 +48463,9 @@ definitions: 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 @@ -56091,19 +48492,20 @@ definitions: 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 @@ -56173,6 +48575,7 @@ definitions: 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. @@ -56225,7 +48628,9 @@ definitions: 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 @@ -56333,7 +48738,8 @@ definitions: 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 @@ -56363,7 +48769,9 @@ definitions: 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 @@ -56392,9 +48800,11 @@ definitions: 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: @@ -56475,7 +48885,9 @@ definitions: 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: @@ -56535,9 +48947,11 @@ definitions: 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 @@ -56583,35 +48997,32 @@ definitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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) + - 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 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 @@ -56709,10 +49120,12 @@ definitions: 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: @@ -56752,9 +49165,11 @@ definitions: 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: @@ -56791,9 +49206,10 @@ definitions: 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: @@ -56831,8 +49247,9 @@ definitions: 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: @@ -56885,8 +49302,10 @@ definitions: 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: @@ -56912,8 +49331,10 @@ definitions: 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: @@ -56980,14 +49401,17 @@ definitions: 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 @@ -57018,6 +49442,7 @@ definitions: 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 @@ -57061,13 +49486,15 @@ definitions: 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 @@ -57104,7 +49531,9 @@ definitions: 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 - bandwidth-up-wan1 @@ -57170,14 +49599,15 @@ definitions: 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 @@ -57268,12 +49698,15 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -57292,6 +49725,7 @@ definitions: 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. @@ -57339,7 +49773,9 @@ definitions: 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: @@ -57369,10 +49805,11 @@ definitions: 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: @@ -57411,10 +49848,11 @@ definitions: 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: @@ -57453,9 +49891,10 @@ definitions: 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 @@ -57485,15 +49924,17 @@ definitions: 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 @@ -57533,11 +49974,13 @@ definitions: 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: @@ -57569,8 +50012,10 @@ definitions: 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 @@ -57609,15 +50054,17 @@ definitions: 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 @@ -57645,8 +50092,10 @@ definitions: 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 @@ -57683,7 +50132,9 @@ definitions: 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 @@ -57705,11 +50156,12 @@ definitions: 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 @@ -57763,11 +50215,12 @@ definitions: 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: @@ -57813,12 +50266,14 @@ definitions: 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 @@ -57866,19 +50321,20 @@ definitions: 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 @@ -57903,8 +50359,10 @@ definitions: 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. @@ -57932,11 +50390,12 @@ definitions: 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 @@ -57974,12 +50433,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -58008,20 +50461,23 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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) + - 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: @@ -58055,15 +50511,18 @@ patchDefinitions: 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 @@ -58124,7 +50583,9 @@ patchDefinitions: 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: @@ -58173,26 +50634,28 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM 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 + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -58224,6 +50687,7 @@ patchDefinitions: 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. @@ -58240,20 +50704,22 @@ patchDefinitions: 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 @@ -58287,13 +50753,15 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -58348,10 +50816,11 @@ patchDefinitions: 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: @@ -58370,10 +50839,12 @@ patchDefinitions: 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 @@ -58394,8 +50865,10 @@ patchDefinitions: 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: @@ -58413,10 +50886,12 @@ patchDefinitions: 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 @@ -58444,8 +50919,9 @@ patchDefinitions: 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 @@ -58486,8 +50962,9 @@ patchDefinitions: 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 @@ -58554,9 +51031,11 @@ patchDefinitions: 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 @@ -58577,8 +51056,10 @@ patchDefinitions: 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 @@ -58601,8 +51082,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -58619,10 +51101,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -58698,9 +51182,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -58723,8 +51208,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -58747,7 +51233,9 @@ patchDefinitions: 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: @@ -58830,9 +51318,11 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -58884,12 +51374,14 @@ patchDefinitions: 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: @@ -58904,7 +51396,9 @@ patchDefinitions: 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: @@ -58939,11 +51433,13 @@ patchDefinitions: 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 @@ -58964,43 +51460,40 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - 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) + - 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: @@ -59104,8 +51597,10 @@ patchDefinitions: 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 @@ -59118,9 +51613,10 @@ patchDefinitions: 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 @@ -59149,7 +51645,9 @@ patchDefinitions: 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 @@ -59185,10 +51683,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -59209,7 +51708,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -59223,11 +51724,13 @@ patchDefinitions: 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 @@ -59289,22 +51792,20 @@ patchDefinitions: 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 @@ -59361,13 +51862,9 @@ patchDefinitions: 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: @@ -59412,9 +51909,10 @@ patchDefinitions: 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: @@ -59497,22 +51995,24 @@ patchDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -59548,6 +52048,7 @@ patchDefinitions: 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. @@ -59560,12 +52061,14 @@ patchDefinitions: 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: @@ -59591,12 +52094,14 @@ patchDefinitions: 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: @@ -59622,23 +52127,24 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - 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) + - 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 @@ -59667,6 +52173,7 @@ patchDefinitions: 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 @@ -59684,16 +52191,18 @@ patchDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -59716,8 +52225,10 @@ patchDefinitions: 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: @@ -59736,8 +52247,10 @@ patchDefinitions: 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 @@ -59760,7 +52273,8 @@ patchDefinitions: 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: @@ -59779,21 +52293,23 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - 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) + - 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 required: - link-name - in-maint @@ -59804,6 +52320,7 @@ patchDefinitions: 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 @@ -59839,11 +52356,13 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -59856,13 +52375,15 @@ patchDefinitions: 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 @@ -59894,9 +52415,11 @@ patchDefinitions: 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 @@ -59919,14 +52442,16 @@ patchDefinitions: 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 @@ -59952,12 +52477,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -59992,7 +52520,8 @@ patchDefinitions: 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 @@ -60025,10 +52554,11 @@ patchDefinitions: 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 @@ -60048,13 +52578,15 @@ patchDefinitions: 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: @@ -60157,8 +52689,9 @@ patchDefinitions: 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: @@ -60175,7 +52708,8 @@ patchDefinitions: 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: @@ -60197,8 +52731,9 @@ patchDefinitions: 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 @@ -60239,6 +52774,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -60294,9 +52835,10 @@ patchDefinitions: 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 @@ -60331,8 +52873,9 @@ patchDefinitions: 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 @@ -60411,7 +52954,8 @@ patchDefinitions: 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 @@ -60426,16 +52970,18 @@ patchDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - 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) + + -(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 @@ -60479,7 +53025,9 @@ patchDefinitions: 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: @@ -60530,7 +53078,8 @@ patchDefinitions: 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: @@ -60549,16 +53098,17 @@ patchDefinitions: 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) + - 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 has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - 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) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -60595,6 +53145,7 @@ patchDefinitions: 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. @@ -60631,9 +53182,11 @@ patchDefinitions: 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 @@ -60660,7 +53213,8 @@ patchDefinitions: 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: @@ -60687,7 +53241,9 @@ patchDefinitions: 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 @@ -60712,19 +53268,20 @@ patchDefinitions: 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 @@ -60794,6 +53351,7 @@ patchDefinitions: 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. @@ -60816,7 +53374,9 @@ patchDefinitions: 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 @@ -60916,7 +53476,8 @@ patchDefinitions: 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 @@ -60939,7 +53500,9 @@ patchDefinitions: 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 @@ -60961,9 +53524,11 @@ patchDefinitions: 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: @@ -61033,7 +53598,9 @@ patchDefinitions: 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: @@ -61076,9 +53643,11 @@ patchDefinitions: 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 @@ -61117,35 +53686,32 @@ patchDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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) + - 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 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 @@ -61222,10 +53788,12 @@ patchDefinitions: 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: @@ -61254,9 +53822,11 @@ patchDefinitions: 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: @@ -61282,9 +53852,10 @@ patchDefinitions: 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: @@ -61311,8 +53882,9 @@ patchDefinitions: 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: @@ -61358,8 +53930,10 @@ patchDefinitions: 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: @@ -61378,8 +53952,10 @@ patchDefinitions: 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: @@ -61436,14 +54012,17 @@ patchDefinitions: 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 @@ -61474,6 +54053,7 @@ patchDefinitions: 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 @@ -61502,13 +54082,15 @@ patchDefinitions: 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 @@ -61534,7 +54116,9 @@ patchDefinitions: 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 - bandwidth-up-wan1 @@ -61593,14 +54177,15 @@ patchDefinitions: 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 @@ -61666,12 +54251,15 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -61690,6 +54278,7 @@ patchDefinitions: 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 @@ -61702,7 +54291,9 @@ patchDefinitions: 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: @@ -61725,10 +54316,11 @@ patchDefinitions: 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: @@ -61754,10 +54346,11 @@ patchDefinitions: 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: @@ -61783,9 +54376,10 @@ patchDefinitions: 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 @@ -61808,15 +54402,17 @@ patchDefinitions: 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 @@ -61852,8 +54448,10 @@ patchDefinitions: 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 @@ -61885,15 +54483,17 @@ patchDefinitions: 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 @@ -61921,8 +54521,10 @@ patchDefinitions: 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 @@ -61944,7 +54546,9 @@ patchDefinitions: 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 @@ -61959,11 +54563,12 @@ patchDefinitions: 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 @@ -62010,11 +54615,12 @@ patchDefinitions: 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: @@ -62045,12 +54651,14 @@ patchDefinitions: 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 @@ -62086,19 +54694,20 @@ patchDefinitions: 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 @@ -62123,8 +54732,10 @@ patchDefinitions: 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. @@ -62137,11 +54748,12 @@ patchDefinitions: 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 @@ -62172,12 +54784,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -62206,20 +54812,23 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - 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) + - 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: @@ -62276,15 +54885,18 @@ getDefinitions: 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 @@ -62352,7 +54964,9 @@ getDefinitions: 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: @@ -62408,26 +55022,28 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM 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 + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -62459,6 +55075,7 @@ getDefinitions: 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. @@ -62530,20 +55147,22 @@ getDefinitions: 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 @@ -62613,13 +55232,15 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -62685,10 +55306,11 @@ getDefinitions: 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: @@ -62733,10 +55355,12 @@ getDefinitions: 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 @@ -62767,8 +55391,10 @@ getDefinitions: 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: @@ -62793,10 +55419,12 @@ getDefinitions: 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 @@ -62831,8 +55459,9 @@ getDefinitions: 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 @@ -62891,8 +55520,9 @@ getDefinitions: 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 @@ -62966,9 +55596,11 @@ getDefinitions: 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 @@ -62999,8 +55631,10 @@ getDefinitions: 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 @@ -63030,8 +55664,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -63057,10 +55692,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -63143,9 +55780,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -63177,8 +55815,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -63210,7 +55849,9 @@ getDefinitions: 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: @@ -63300,9 +55941,11 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -63361,12 +56004,14 @@ getDefinitions: 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: @@ -63388,7 +56033,9 @@ getDefinitions: 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: @@ -63430,11 +56077,13 @@ getDefinitions: 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 @@ -63469,43 +56118,40 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - 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) + - 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: @@ -63609,8 +56255,10 @@ getDefinitions: 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. @@ -63721,9 +56369,10 @@ getDefinitions: 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 @@ -63759,7 +56408,9 @@ getDefinitions: 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 @@ -63802,10 +56453,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -63837,7 +56489,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -63858,11 +56512,13 @@ getDefinitions: 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 @@ -63935,22 +56591,20 @@ getDefinitions: 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 @@ -64014,13 +56668,9 @@ getDefinitions: 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: @@ -64065,9 +56715,10 @@ getDefinitions: 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: @@ -64161,22 +56812,24 @@ getDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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 sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - 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 @@ -64212,16 +56865,19 @@ getDefinitions: 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. @@ -64261,12 +56917,14 @@ getDefinitions: 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: @@ -64305,12 +56963,14 @@ getDefinitions: 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: @@ -64349,23 +57009,24 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - 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) + - 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 @@ -64394,6 +57055,7 @@ getDefinitions: 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 @@ -64439,10 +57101,13 @@ getDefinitions: 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. @@ -64476,16 +57141,18 @@ getDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - 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) + + -(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 @@ -64516,6 +57183,7 @@ getDefinitions: 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: @@ -64536,8 +57204,10 @@ getDefinitions: 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: @@ -64563,8 +57233,10 @@ getDefinitions: 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 @@ -64594,7 +57266,8 @@ getDefinitions: 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: @@ -64620,21 +57293,23 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - 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) + - 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 required: - link-name - in-maint @@ -64645,6 +57320,7 @@ getDefinitions: 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 @@ -64723,11 +57399,13 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -64743,13 +57421,15 @@ getDefinitions: 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 @@ -64792,9 +57472,11 @@ getDefinitions: 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 @@ -64820,14 +57502,16 @@ getDefinitions: 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 @@ -64870,12 +57554,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -64925,7 +57612,8 @@ getDefinitions: 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 @@ -64965,10 +57653,11 @@ getDefinitions: 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 @@ -64998,13 +57687,15 @@ getDefinitions: 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: @@ -65129,8 +57820,9 @@ getDefinitions: 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: @@ -65154,7 +57846,8 @@ getDefinitions: 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: @@ -65183,8 +57876,9 @@ getDefinitions: 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 @@ -65248,6 +57942,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -65303,9 +58003,10 @@ getDefinitions: 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 @@ -65347,8 +58048,9 @@ getDefinitions: 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 @@ -65443,7 +58145,8 @@ getDefinitions: 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 @@ -65465,16 +58168,18 @@ getDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - 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) + + -(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 @@ -65511,6 +58216,7 @@ getDefinitions: 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 @@ -65538,7 +58244,9 @@ getDefinitions: 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: @@ -65596,7 +58304,8 @@ getDefinitions: 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: @@ -65622,16 +58331,17 @@ getDefinitions: 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) + - 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 has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - 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) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -65668,6 +58378,7 @@ getDefinitions: 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. @@ -65725,9 +58436,11 @@ getDefinitions: 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 @@ -65783,7 +58496,8 @@ getDefinitions: 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: @@ -65817,7 +58531,9 @@ getDefinitions: 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 @@ -65844,19 +58560,20 @@ getDefinitions: 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 @@ -65926,6 +58643,7 @@ getDefinitions: 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. @@ -65978,7 +58696,9 @@ getDefinitions: 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 @@ -66090,7 +58810,8 @@ getDefinitions: 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 @@ -66120,7 +58841,9 @@ getDefinitions: 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 @@ -66149,9 +58872,11 @@ getDefinitions: 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: @@ -66232,7 +58957,9 @@ getDefinitions: 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: @@ -66292,9 +59019,11 @@ getDefinitions: 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 @@ -66340,35 +59069,32 @@ getDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - 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) + - 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 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 @@ -66466,10 +59192,12 @@ getDefinitions: 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: @@ -66509,9 +59237,11 @@ getDefinitions: 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: @@ -66548,9 +59278,10 @@ getDefinitions: 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: @@ -66588,8 +59319,9 @@ getDefinitions: 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: @@ -66642,8 +59374,10 @@ getDefinitions: 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: @@ -66669,8 +59403,10 @@ getDefinitions: 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: @@ -66737,14 +59473,17 @@ getDefinitions: 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 @@ -66775,6 +59514,7 @@ getDefinitions: 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 @@ -66818,13 +59558,15 @@ getDefinitions: 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 @@ -66861,7 +59603,9 @@ getDefinitions: 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 - bandwidth-up-wan1 @@ -66927,14 +59671,15 @@ getDefinitions: 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 @@ -67025,12 +59770,15 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -67049,6 +59797,7 @@ getDefinitions: 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. @@ -67096,7 +59845,9 @@ getDefinitions: 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: @@ -67126,10 +59877,11 @@ getDefinitions: 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: @@ -67168,10 +59920,11 @@ getDefinitions: 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: @@ -67210,9 +59963,10 @@ getDefinitions: 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 @@ -67242,15 +59996,17 @@ getDefinitions: 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 @@ -67290,11 +60046,13 @@ getDefinitions: 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: @@ -67326,8 +60084,10 @@ getDefinitions: 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 @@ -67366,15 +60126,17 @@ getDefinitions: 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 @@ -67402,8 +60164,10 @@ getDefinitions: 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 @@ -67440,7 +60204,9 @@ getDefinitions: 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 @@ -67462,11 +60228,12 @@ getDefinitions: 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 @@ -67520,11 +60287,12 @@ getDefinitions: 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: @@ -67570,12 +60338,14 @@ getDefinitions: 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 @@ -67623,19 +60393,20 @@ getDefinitions: 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 @@ -67660,8 +60431,10 @@ getDefinitions: 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. @@ -67689,11 +60462,12 @@ getDefinitions: 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 diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml index 130578d4..b4aac6c7 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 @@ -756,7 +712,7 @@ paths: 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" @@ -829,214 +785,32 @@ paths: 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/v12/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 @@ -1079,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/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 @@ -1140,25 +903,21 @@ paths: 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: @@ -1192,26 +951,22 @@ paths: 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: @@ -1239,55 +994,35 @@ paths: 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/v12/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 @@ -1322,18 +1057,24 @@ paths: 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/v12/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 @@ -1368,19 +1109,32 @@ paths: 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: @@ -1408,21 +1162,54 @@ paths: 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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1431,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1466,24 +1253,12 @@ paths: 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 @@ -1530,15 +1305,9 @@ paths: 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/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1547,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1594,27 +1363,19 @@ paths: 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: @@ -1660,91 +1421,130 @@ paths: 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/v12/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 @@ -1883,7 +1683,7 @@ paths: 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" @@ -2132,91 +1932,6 @@ paths: 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 @@ -2355,7 +2070,7 @@ paths: 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" @@ -2476,75 +2191,6 @@ paths: 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 @@ -2671,7 +2317,7 @@ paths: 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" @@ -2780,62 +2426,20 @@ paths: 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: @@ -3002,84 +2606,6 @@ paths: 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 @@ -3206,7 +2732,7 @@ paths: 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" @@ -3315,62 +2841,29 @@ paths: 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: @@ -3635,80 +3128,6 @@ paths: 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 @@ -3835,7 +3254,7 @@ paths: 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" @@ -4060,80 +3479,6 @@ paths: 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 @@ -4260,7 +3605,7 @@ paths: 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" @@ -4369,64 +3714,6 @@ paths: 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 @@ -4541,7 +3828,7 @@ paths: 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" @@ -4638,49 +3925,26 @@ paths: 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: @@ -4723,49 +3987,6 @@ paths: 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 @@ -4868,7 +4089,7 @@ paths: 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" @@ -4953,26 +4174,36 @@ paths: 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: @@ -5083,26 +4314,6 @@ paths: 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 @@ -5193,7 +4404,7 @@ paths: 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" @@ -5266,14 +4477,19 @@ paths: 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: + required: false + type: string + - name: tenant-context in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: @@ -5508,31 +4724,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5647,7 +4838,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -5744,31 +4935,6 @@ paths: 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5871,7 +5037,7 @@ paths: 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" @@ -5956,19 +5122,19 @@ paths: required: true type: string example: __FLAVOR-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: 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: @@ -6081,21 +5247,6 @@ paths: 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 @@ -6186,7 +5337,7 @@ paths: 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" @@ -6259,14 +5410,14 @@ paths: 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: @@ -6379,26 +5530,6 @@ paths: 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 @@ -6489,7 +5620,7 @@ paths: 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" @@ -6562,14 +5693,19 @@ paths: 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: @@ -6682,41 +5818,6 @@ paths: 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 @@ -6807,7 +5908,7 @@ paths: 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" @@ -6880,14 +5981,34 @@ paths: 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: @@ -7005,36 +6126,6 @@ paths: 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 @@ -7135,7 +6226,7 @@ paths: 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" @@ -7219,34 +6310,9 @@ paths: 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}: @@ -7285,36 +6351,6 @@ paths: 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 @@ -7405,7 +6441,7 @@ paths: 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" @@ -7478,14 +6514,29 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -7598,21 +6649,6 @@ paths: 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 @@ -7703,7 +6739,7 @@ paths: 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" @@ -7776,14 +6812,14 @@ paths: 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: @@ -7896,27 +6932,6 @@ paths: 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 @@ -8007,7 +7022,7 @@ paths: 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" @@ -8080,16 +7095,22 @@ paths: 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: @@ -8200,16 +7221,6 @@ paths: 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 @@ -8300,7 +7311,7 @@ paths: 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" @@ -8373,14 +7384,9 @@ paths: 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: @@ -8555,32 +7561,6 @@ paths: 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 @@ -8671,7 +7651,7 @@ paths: 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" @@ -8824,32 +7804,6 @@ paths: 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 @@ -8940,7 +7894,7 @@ paths: 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" @@ -9185,26 +8139,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9307,7 +8241,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -9392,26 +8326,6 @@ paths: 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9502,7 +8416,7 @@ paths: 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" @@ -9575,14 +8489,19 @@ paths: 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}: @@ -9615,16 +8534,6 @@ paths: 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 @@ -9703,7 +8612,7 @@ paths: 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" @@ -9757,6 +8666,27 @@ paths: $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: @@ -9897,7 +8827,7 @@ paths: 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" @@ -9945,6 +8875,12 @@ paths: $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: @@ -10167,30 +9103,6 @@ paths: 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 @@ -10281,7 +9193,7 @@ paths: 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" @@ -10354,28 +9266,9 @@ paths: 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: @@ -10610,72 +9503,6 @@ paths: 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 @@ -10790,7 +9617,7 @@ paths: 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" @@ -10991,196 +9818,130 @@ paths: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - 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/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11268,56 +10029,6 @@ paths: 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 @@ -11420,7 +10131,7 @@ paths: 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" @@ -11505,43 +10216,20 @@ paths: 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: @@ -11672,65 +10360,6 @@ paths: 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: 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: - CloudInfrastructure @@ -11833,7 +10462,7 @@ paths: 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" @@ -11918,43 +10547,29 @@ paths: 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: @@ -12159,61 +10774,6 @@ paths: 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 @@ -12316,7 +10876,7 @@ paths: 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" @@ -12493,61 +11053,6 @@ paths: 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 @@ -12650,7 +11155,7 @@ paths: 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" @@ -12735,45 +11240,6 @@ paths: 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 @@ -12864,7 +11330,7 @@ paths: 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" @@ -12937,28 +11403,24 @@ paths: 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}: @@ -12991,30 +11453,6 @@ paths: 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 @@ -13093,7 +11531,7 @@ paths: 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" @@ -13154,23 +11592,14 @@ paths: 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: @@ -13467,77 +11896,6 @@ paths: 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 @@ -13652,7 +12010,7 @@ paths: 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" @@ -13853,77 +12211,6 @@ paths: 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 @@ -14038,7 +12325,7 @@ paths: 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" @@ -14135,61 +12422,6 @@ paths: 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 @@ -14292,7 +12524,7 @@ paths: 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" @@ -14377,48 +12609,20 @@ paths: 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: @@ -14549,70 +12753,6 @@ paths: 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 @@ -14715,7 +12855,7 @@ paths: 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" @@ -14800,48 +12940,29 @@ paths: 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: @@ -15046,66 +13167,6 @@ paths: 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 @@ -15208,7 +13269,7 @@ paths: 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" @@ -15385,66 +13446,6 @@ paths: 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 @@ -15547,7 +13548,7 @@ paths: 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" @@ -15632,50 +13633,6 @@ paths: 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 @@ -15766,7 +13723,7 @@ paths: 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" @@ -15839,33 +13796,24 @@ paths: 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}: @@ -15898,35 +13846,6 @@ paths: 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 @@ -16005,7 +13924,7 @@ paths: 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" @@ -16066,23 +13985,19 @@ paths: 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}: @@ -16109,25 +14024,6 @@ paths: 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 @@ -16194,7 +14090,7 @@ paths: 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" @@ -16242,6 +14138,32 @@ paths: $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: @@ -16316,11 +14238,6 @@ paths: 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 @@ -16387,7 +14304,7 @@ paths: 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" @@ -16435,6 +14352,17 @@ paths: $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: @@ -16575,7 +14503,7 @@ paths: 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" @@ -16623,6 +14551,12 @@ paths: $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: @@ -16702,26 +14636,6 @@ paths: 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 @@ -16798,7 +14712,7 @@ paths: 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" @@ -16858,24 +14772,9 @@ paths: 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}: @@ -16902,26 +14801,6 @@ paths: 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 @@ -16988,7 +14867,7 @@ paths: 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" @@ -17036,185 +14915,156 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: - put: - tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - 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__ - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: - get: - tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/metadatum" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: 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: 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: resource-instance-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. + 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. - 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}/relationship-list/relationship: 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 + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - 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__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: 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__ + 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 @@ -17306,7 +15156,7 @@ paths: 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" @@ -17390,59 +15240,9 @@ paths: 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 + - name: metaname 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: @@ -17591,81 +15391,6 @@ paths: 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 @@ -17780,7 +15505,7 @@ paths: 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" @@ -17877,79 +15602,9 @@ paths: 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: @@ -18080,81 +15735,6 @@ paths: 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 @@ -18257,7 +15837,7 @@ paths: 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" @@ -18342,59 +15922,29 @@ paths: 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. - 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. + description: 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}: @@ -18433,61 +15983,6 @@ paths: 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 @@ -18578,7 +16073,7 @@ paths: 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" @@ -18651,14 +16146,54 @@ paths: 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: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -18753,16 +16288,6 @@ paths: 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 @@ -18841,7 +16366,7 @@ paths: 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" @@ -18902,14 +16427,9 @@ paths: 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: @@ -18986,16 +16506,6 @@ paths: 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 @@ -19062,7 +16572,7 @@ paths: 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" @@ -19110,6 +16620,22 @@ paths: $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: @@ -19250,7 +16776,7 @@ paths: 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" @@ -19298,6 +16824,12 @@ paths: $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: @@ -19438,7 +16970,7 @@ paths: 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" @@ -19486,6 +17018,12 @@ paths: $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: @@ -19626,7 +17164,7 @@ paths: 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" @@ -19674,6 +17212,12 @@ paths: $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: @@ -19814,7 +17358,7 @@ paths: 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" @@ -19862,6 +17406,12 @@ paths: $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: @@ -19936,21 +17486,6 @@ paths: 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 @@ -20017,7 +17552,7 @@ paths: 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" @@ -20065,6 +17600,27 @@ paths: $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: @@ -20139,11 +17695,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20210,7 +17761,7 @@ paths: 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" @@ -20258,6 +17809,17 @@ paths: $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: @@ -20428,7 +17990,7 @@ paths: 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" @@ -20482,6 +18044,17 @@ paths: $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: @@ -20634,26 +18207,6 @@ paths: 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 @@ -20772,7 +18325,7 @@ paths: 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" @@ -20874,24 +18427,9 @@ paths: 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: @@ -21031,26 +18569,6 @@ paths: 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 @@ -21159,7 +18677,7 @@ paths: 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" @@ -21251,24 +18769,9 @@ paths: 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}: @@ -21311,232 +18814,197 @@ paths: 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true type: string - - name: model-version + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/model-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: resource-version in: query - description: Version - required: false + description: resource-version for concurrency + required: true type: string - - name: distribution-status + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: 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: put: tags: - ServiceDesignAndCreation - summary: create or update an existing model-constraint - description: | - Create or update an existing model-constraint. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) - required: true - schema: - $ref: "#/definitions/model-constraint" - patch: - tags: - - ServiceDesignAndCreation - summary: update an existing model-constraint - description: | - Update an existing model-constraint - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/model-constraint" - delete: - tags: - - ServiceDesignAndCreation - summary: delete an existing model-constraint - description: delete an existing model-constraint - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: - get: - tags: - - ServiceDesignAndCreation - summary: returns model-constraints - description: returns model-constraints - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/model-constraints" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-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 - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: - put: - tags: - - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship consumes: - application/json - application/xml @@ -21638,26 +19106,6 @@ paths: 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 @@ -21746,7 +19194,7 @@ paths: 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" @@ -21818,24 +19266,9 @@ paths: 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}: @@ -21873,26 +19306,6 @@ paths: 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 @@ -21981,7 +19394,7 @@ paths: 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" @@ -22053,24 +19466,9 @@ paths: 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: @@ -22165,26 +19563,6 @@ paths: 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 @@ -22263,7 +19641,7 @@ paths: 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" @@ -22324,9 +19702,24 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type + - name: model-version-id in: query - description: Type of the model, e.g., service, resource, widget, etc. + 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: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -22403,11 +19796,6 @@ paths: 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 @@ -22474,7 +19862,7 @@ paths: 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" @@ -22522,6 +19910,17 @@ paths: $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: @@ -22623,10 +20022,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22711,7 +20106,7 @@ paths: 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" @@ -22779,8 +20174,9 @@ paths: 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}: @@ -22816,10 +20212,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22904,7 +20296,7 @@ paths: 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" @@ -22972,8 +20364,9 @@ paths: 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: @@ -23062,10 +20455,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23140,7 +20529,7 @@ paths: 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" @@ -23198,8 +20587,9 @@ paths: 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: @@ -23273,10 +20663,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23341,7 +20727,7 @@ paths: 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" @@ -23388,6 +20774,17 @@ paths: $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: @@ -23462,46 +20859,6 @@ paths: 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 @@ -23568,7 +20925,7 @@ paths: 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" @@ -23616,6 +20973,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: 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: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - 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: @@ -23846,7 +21249,7 @@ paths: 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" @@ -23931,6 +21334,11 @@ paths: 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: @@ -24131,7 +21539,7 @@ paths: 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" @@ -24204,6 +21612,11 @@ paths: 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: @@ -24374,7 +21787,7 @@ paths: 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" @@ -24435,6 +21848,11 @@ paths: 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: @@ -24575,7 +21993,7 @@ paths: 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" @@ -24623,135 +22041,131 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: - get: - tags: - - Network - summary: returns route-target - description: returns route-target - operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/route-target" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type + - name: site-pair-set-id in: query - description: Type of the vpn, should be taken from enumerated/valid values + 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: - Network - summary: create or update an existing route-target - description: | - Create or update an existing route-target. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: + tags: + - Network + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + put: + tags: + - Network + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -24833,7 +22247,7 @@ paths: 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" @@ -24900,16 +22314,6 @@ paths: 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: @@ -24984,16 +22388,6 @@ paths: 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 @@ -25060,7 +22454,7 @@ paths: 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" @@ -25108,6 +22502,22 @@ paths: $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: @@ -25323,16 +22733,6 @@ paths: 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 @@ -25421,7 +22821,7 @@ paths: 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" @@ -25492,14 +22892,9 @@ paths: 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: @@ -25729,58 +23124,6 @@ paths: 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 @@ -25893,7 +23236,7 @@ paths: 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" @@ -26090,58 +23433,6 @@ paths: 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 @@ -26254,7 +23545,7 @@ paths: 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" @@ -26349,42 +23640,6 @@ paths: 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 @@ -26485,7 +23740,7 @@ paths: 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" @@ -26568,29 +23823,20 @@ paths: 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: @@ -26718,51 +23964,6 @@ paths: 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 @@ -26863,7 +24064,7 @@ paths: 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" @@ -26946,29 +24147,29 @@ paths: 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: @@ -27168,47 +24369,6 @@ paths: 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 @@ -27309,7 +24469,7 @@ paths: 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" @@ -27482,47 +24642,6 @@ paths: 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 @@ -27623,7 +24742,7 @@ paths: 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" @@ -27706,31 +24825,6 @@ paths: 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 @@ -27819,7 +24913,7 @@ paths: 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" @@ -27890,14 +24984,24 @@ paths: 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}: @@ -27929,16 +25033,6 @@ paths: 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 @@ -28015,7 +25109,7 @@ paths: 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" @@ -28074,9 +25168,14 @@ paths: 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: @@ -28366,63 +25465,6 @@ paths: 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 @@ -28535,7 +25577,7 @@ paths: 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" @@ -28732,63 +25774,6 @@ paths: 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 @@ -28901,7 +25886,7 @@ paths: 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" @@ -28996,47 +25981,6 @@ paths: 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 @@ -29137,7 +26081,7 @@ paths: 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" @@ -29220,34 +26164,20 @@ paths: 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: @@ -29375,56 +26305,6 @@ paths: 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 @@ -29525,7 +26405,7 @@ paths: 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" @@ -29608,34 +26488,29 @@ paths: 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: @@ -29835,52 +26710,6 @@ paths: 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 @@ -29981,7 +26810,7 @@ paths: 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" @@ -30154,162 +26983,116 @@ paths: 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/v12/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/v12/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 @@ -30383,36 +27166,6 @@ paths: 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 @@ -30501,7 +27254,7 @@ paths: 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" @@ -30572,19 +27325,24 @@ paths: 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}: @@ -30616,21 +27374,6 @@ paths: 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 @@ -30707,7 +27450,7 @@ paths: 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" @@ -30766,9 +27509,19 @@ paths: 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}: @@ -30794,11 +27547,6 @@ paths: 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 @@ -30863,7 +27611,7 @@ paths: 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" @@ -30910,6 +27658,17 @@ paths: $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: @@ -31050,7 +27809,7 @@ paths: 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" @@ -31098,6 +27857,12 @@ paths: $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: @@ -31211,61 +27976,6 @@ paths: 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 @@ -31358,7 +28068,7 @@ paths: 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" @@ -31432,61 +28142,12 @@ paths: 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: @@ -31579,61 +28240,6 @@ paths: 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 @@ -31712,7 +28318,7 @@ paths: 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" @@ -31773,44 +28379,24 @@ paths: 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: @@ -31923,46 +28509,6 @@ paths: 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 @@ -32053,7 +28599,7 @@ paths: 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" @@ -32120,44 +28666,14 @@ paths: 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: @@ -32270,46 +28786,6 @@ paths: 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 @@ -32400,7 +28876,7 @@ paths: 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" @@ -32467,44 +28943,14 @@ paths: 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: @@ -32581,46 +29027,6 @@ paths: 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 @@ -32687,7 +29093,7 @@ paths: 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" @@ -32735,6 +29141,52 @@ paths: $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: @@ -32877,65 +29329,6 @@ paths: 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 @@ -33014,7 +29407,7 @@ paths: 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" @@ -33143,65 +29536,6 @@ paths: 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 @@ -33280,7 +29614,7 @@ paths: 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" @@ -33341,49 +29675,6 @@ paths: 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 @@ -33450,7 +29741,7 @@ paths: 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" @@ -33498,6 +29789,57 @@ paths: $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: @@ -33608,56 +29950,6 @@ paths: 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 @@ -33748,7 +30040,7 @@ paths: 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" @@ -33821,54 +30113,9 @@ paths: 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: @@ -33963,56 +30210,6 @@ paths: 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 @@ -34091,7 +30288,7 @@ paths: 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" @@ -34152,49 +30349,14 @@ paths: 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: @@ -34292,51 +30454,6 @@ paths: 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 @@ -34417,7 +30534,7 @@ paths: 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" @@ -34479,51 +30596,12 @@ paths: 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: @@ -34616,51 +30694,6 @@ paths: 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 @@ -34739,7 +30772,7 @@ paths: 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" @@ -34800,49 +30833,9 @@ paths: 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: @@ -34919,51 +30912,6 @@ paths: 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 @@ -35030,7 +30978,7 @@ paths: 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" @@ -35078,6 +31026,57 @@ paths: $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: @@ -35152,11 +31151,6 @@ paths: 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 @@ -35223,7 +31217,7 @@ paths: 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" @@ -35271,6 +31265,17 @@ paths: $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: @@ -35523,131 +31528,6 @@ paths: 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 @@ -35750,7 +31630,7 @@ paths: 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" @@ -35927,131 +31807,6 @@ paths: 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 @@ -36154,7 +31909,7 @@ paths: 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" @@ -36239,115 +31994,6 @@ paths: 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 @@ -36438,7 +32084,7 @@ paths: 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" @@ -36511,102 +32157,20 @@ paths: 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: @@ -36719,124 +32283,6 @@ paths: 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 @@ -36927,7 +32373,7 @@ paths: 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" @@ -37000,102 +32446,29 @@ paths: 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: @@ -37270,120 +32643,6 @@ paths: 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 @@ -37474,7 +32733,7 @@ paths: 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" @@ -37627,120 +32886,6 @@ paths: 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 @@ -37831,7 +32976,7 @@ paths: 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" @@ -37904,104 +33049,6 @@ paths: 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 @@ -38080,7 +33127,7 @@ paths: 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" @@ -38141,87 +33188,24 @@ paths: 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: @@ -38518,141 +33502,6 @@ paths: 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 @@ -38767,7 +33616,7 @@ paths: 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" @@ -38968,141 +33817,6 @@ paths: 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 @@ -39217,7 +33931,7 @@ paths: 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" @@ -39314,125 +34028,6 @@ paths: 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 @@ -39535,7 +34130,7 @@ paths: 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" @@ -39620,112 +34215,20 @@ paths: 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: @@ -39856,134 +34359,6 @@ paths: 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 @@ -40086,7 +34461,7 @@ paths: 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" @@ -40171,112 +34546,29 @@ paths: 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: @@ -40481,159 +34773,35 @@ paths: 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 @@ -40707,7 +34875,7 @@ paths: 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" @@ -40884,130 +35052,6 @@ paths: 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 @@ -41110,7 +35154,7 @@ paths: 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" @@ -41195,114 +35239,6 @@ paths: 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 @@ -41393,7 +35329,7 @@ paths: 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" @@ -41466,97 +35402,24 @@ paths: 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}: @@ -41589,99 +35452,6 @@ paths: 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 @@ -41760,7 +35530,7 @@ paths: 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" @@ -41821,87 +35591,19 @@ paths: 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: @@ -41996,124 +35698,6 @@ paths: 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 @@ -42192,7 +35776,7 @@ paths: 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" @@ -42253,87 +35837,44 @@ paths: 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: @@ -42446,89 +35987,6 @@ paths: 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 @@ -42619,7 +36077,7 @@ paths: 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" @@ -42686,87 +36144,14 @@ paths: 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: @@ -42879,89 +36264,6 @@ paths: 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 @@ -43052,7 +36354,7 @@ paths: 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" @@ -43119,87 +36421,14 @@ paths: 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}: @@ -43226,89 +36455,6 @@ paths: 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 @@ -43375,7 +36521,7 @@ paths: 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" @@ -43423,6 +36569,97 @@ paths: $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: @@ -43563,7 +36800,7 @@ paths: 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" @@ -43611,6 +36848,12 @@ paths: $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: @@ -43863,73 +37106,6 @@ paths: 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 @@ -44032,7 +37208,7 @@ paths: 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" @@ -44209,73 +37385,6 @@ paths: 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 @@ -44378,7 +37487,7 @@ paths: 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" @@ -44463,57 +37572,6 @@ paths: 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 @@ -44604,7 +37662,7 @@ paths: 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" @@ -44677,44 +37735,20 @@ paths: 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: @@ -44751,142 +37785,82 @@ paths: 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/v12/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/v12/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 @@ -44977,7 +37951,7 @@ paths: 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" @@ -45050,44 +38024,29 @@ paths: 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: @@ -45262,62 +38221,6 @@ paths: 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 @@ -45408,7 +38311,7 @@ paths: 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" @@ -45561,62 +38464,6 @@ paths: 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 @@ -45707,7 +38554,7 @@ paths: 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" @@ -45780,46 +38627,6 @@ paths: 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 @@ -45898,7 +38705,7 @@ paths: 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" @@ -45959,29 +38766,24 @@ paths: 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}: @@ -46008,31 +38810,6 @@ paths: 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 @@ -46099,7 +38876,7 @@ paths: 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" @@ -46147,6 +38924,37 @@ paths: $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: @@ -46369,16 +39177,6 @@ paths: 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 @@ -46469,7 +39267,7 @@ paths: 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" @@ -46542,14 +39340,9 @@ paths: 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: @@ -46784,58 +39577,6 @@ paths: 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 @@ -46950,7 +39691,7 @@ paths: 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" @@ -47151,58 +39892,6 @@ paths: 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 @@ -47317,7 +40006,7 @@ paths: 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" @@ -47414,42 +40103,6 @@ paths: 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 @@ -47552,7 +40205,7 @@ paths: 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" @@ -47637,29 +40290,20 @@ paths: 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: @@ -47790,51 +40434,6 @@ paths: 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 @@ -47937,7 +40536,7 @@ paths: 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" @@ -48022,29 +40621,29 @@ paths: 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: @@ -48249,47 +40848,6 @@ paths: 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 @@ -48392,7 +40950,7 @@ paths: 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" @@ -48569,47 +41127,6 @@ paths: 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 @@ -48712,7 +41229,7 @@ paths: 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" @@ -48797,31 +41314,6 @@ paths: 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 @@ -48912,7 +41404,7 @@ paths: 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" @@ -48985,14 +41477,24 @@ paths: 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}: @@ -49025,16 +41527,6 @@ paths: 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 @@ -49113,7 +41605,7 @@ paths: 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" @@ -49174,9 +41666,14 @@ paths: 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: @@ -49473,63 +41970,6 @@ paths: 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 @@ -49644,7 +42084,7 @@ paths: 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" @@ -49845,63 +42285,6 @@ paths: 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 @@ -50016,7 +42399,7 @@ paths: 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" @@ -50113,47 +42496,6 @@ paths: 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 @@ -50256,7 +42598,7 @@ paths: 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" @@ -50341,34 +42683,20 @@ paths: 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: @@ -50457,98 +42785,48 @@ paths: 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 @@ -50651,7 +42929,7 @@ paths: 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" @@ -50736,34 +43014,29 @@ paths: 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: @@ -50968,52 +43241,6 @@ paths: 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 @@ -51116,7 +43343,7 @@ paths: 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" @@ -51293,52 +43520,6 @@ paths: 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 @@ -51441,7 +43622,7 @@ paths: 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" @@ -51526,36 +43707,6 @@ paths: 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 @@ -51646,7 +43797,7 @@ paths: 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" @@ -51719,19 +43870,24 @@ paths: 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}: @@ -51764,21 +43920,6 @@ paths: 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 @@ -51857,7 +43998,7 @@ paths: 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" @@ -51918,9 +44059,19 @@ paths: 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}: @@ -51947,11 +44098,6 @@ paths: 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 @@ -52018,7 +44164,7 @@ paths: 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" @@ -52066,6 +44212,17 @@ paths: $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: @@ -52140,11 +44297,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -52211,7 +44363,7 @@ paths: 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" @@ -52259,6 +44411,17 @@ paths: $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: @@ -52479,7 +44642,7 @@ paths: 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" @@ -52540,6 +44703,11 @@ paths: 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: @@ -52630,7 +44798,7 @@ paths: 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" @@ -52678,6 +44846,12 @@ paths: $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: @@ -52752,11 +44926,6 @@ paths: 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 @@ -52823,7 +44992,7 @@ paths: 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" @@ -52871,6 +45040,17 @@ paths: $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: @@ -52945,21 +45125,6 @@ paths: 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 @@ -53026,7 +45191,7 @@ paths: 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" @@ -53074,6 +45239,27 @@ paths: $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: @@ -53148,16 +45334,6 @@ paths: 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 @@ -53224,7 +45400,7 @@ paths: 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" @@ -53272,6 +45448,22 @@ paths: $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: @@ -53351,16 +45543,6 @@ paths: 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 @@ -53437,7 +45619,7 @@ paths: 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" @@ -53497,14 +45679,9 @@ paths: 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: @@ -53599,16 +45776,6 @@ paths: 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 @@ -53687,7 +45854,7 @@ paths: 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" @@ -53748,16 +45915,6 @@ paths: 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: @@ -53850,16 +46007,6 @@ paths: 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 @@ -53938,7 +46085,7 @@ paths: 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" @@ -53999,16 +46146,6 @@ paths: 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: @@ -54033,16 +46170,6 @@ paths: 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 @@ -54109,7 +46236,7 @@ paths: 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" @@ -54157,6 +46284,22 @@ paths: $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: @@ -54302,11 +46445,6 @@ paths: type: integer format: int32 example: __SEQUENCE__ - - name: forwarding-path-name - in: query - description: Name of the FP - required: false - type: string put: tags: - Network @@ -54387,7 +46525,7 @@ paths: 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" @@ -54449,11 +46587,12 @@ paths: 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: @@ -54478,11 +46617,6 @@ paths: 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 @@ -54549,7 +46683,7 @@ paths: 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" @@ -54597,13 +46731,18 @@ paths: $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: @@ -54632,21 +46771,24 @@ definitions: 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: @@ -54703,15 +46845,18 @@ definitions: 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 @@ -54779,7 +46924,9 @@ definitions: 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: @@ -54839,27 +46986,29 @@ definitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -54891,6 +47040,7 @@ definitions: 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. @@ -54963,20 +47113,22 @@ definitions: 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 @@ -55046,19 +47198,21 @@ definitions: 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 @@ -55138,10 +47292,11 @@ definitions: 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: @@ -55186,10 +47341,12 @@ definitions: 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 @@ -55220,8 +47377,10 @@ definitions: 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: @@ -55246,10 +47405,12 @@ definitions: 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 @@ -55284,8 +47445,9 @@ definitions: 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 @@ -55344,8 +47506,9 @@ definitions: 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 @@ -55421,9 +47584,11 @@ definitions: 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 @@ -55454,8 +47619,10 @@ definitions: 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 @@ -55485,8 +47652,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -55512,10 +47680,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -55597,9 +47767,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -55631,8 +47802,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -55664,7 +47836,9 @@ definitions: 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: @@ -55754,10 +47928,12 @@ definitions: 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 @@ -55821,12 +47997,14 @@ definitions: 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: @@ -55848,7 +48026,9 @@ definitions: 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: @@ -55890,11 +48070,13 @@ definitions: 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 @@ -55929,44 +48111,41 @@ definitions: 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: @@ -56070,8 +48249,10 @@ definitions: 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. @@ -56182,9 +48363,10 @@ definitions: 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 @@ -56220,7 +48402,9 @@ definitions: 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 @@ -56263,10 +48447,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -56298,7 +48483,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -56319,11 +48506,13 @@ definitions: 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 @@ -56396,22 +48585,20 @@ definitions: 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 @@ -56475,13 +48662,9 @@ definitions: 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: @@ -56526,9 +48709,10 @@ definitions: 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: @@ -56622,26 +48806,28 @@ definitions: 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 @@ -56677,16 +48863,19 @@ definitions: 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. @@ -56726,12 +48915,14 @@ definitions: 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: @@ -56770,12 +48961,14 @@ definitions: 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: @@ -56814,24 +49007,25 @@ definitions: 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 @@ -56860,6 +49054,7 @@ definitions: 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 @@ -56905,10 +49100,13 @@ definitions: 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. @@ -56942,17 +49140,19 @@ definitions: 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 @@ -56983,6 +49183,7 @@ definitions: 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: @@ -57003,8 +49204,10 @@ definitions: 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: @@ -57030,8 +49233,10 @@ definitions: 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 @@ -57061,7 +49266,8 @@ definitions: 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: @@ -57087,24 +49293,27 @@ definitions: 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 @@ -57115,6 +49324,7 @@ definitions: 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 @@ -57193,11 +49403,13 @@ definitions: 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 @@ -57213,13 +49425,15 @@ definitions: 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 @@ -57262,9 +49476,11 @@ definitions: 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 @@ -57290,14 +49506,16 @@ definitions: 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 @@ -57340,18 +49558,21 @@ definitions: 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 @@ -57404,7 +49625,8 @@ definitions: 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 @@ -57444,10 +49666,11 @@ definitions: 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 @@ -57477,13 +49700,15 @@ definitions: 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: @@ -57612,8 +49837,9 @@ definitions: 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: @@ -57637,7 +49863,8 @@ definitions: 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: @@ -57666,8 +49893,9 @@ definitions: 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 @@ -57731,6 +49959,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -57786,9 +50020,10 @@ definitions: 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 @@ -57830,8 +50065,9 @@ definitions: 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 @@ -57926,7 +50162,8 @@ definitions: 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 @@ -57948,17 +50185,19 @@ definitions: 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 @@ -57998,6 +50237,7 @@ definitions: 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 @@ -58025,7 +50265,9 @@ definitions: 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: @@ -58083,7 +50325,8 @@ definitions: 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: @@ -58109,17 +50352,18 @@ definitions: 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) + - 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 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 + - 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 @@ -58159,6 +50403,7 @@ definitions: 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. @@ -58216,9 +50461,11 @@ definitions: 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 @@ -58274,7 +50521,8 @@ definitions: 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: @@ -58308,7 +50556,9 @@ definitions: 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 @@ -58335,19 +50585,20 @@ definitions: 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 @@ -58417,6 +50668,7 @@ definitions: 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. @@ -58469,7 +50721,9 @@ definitions: 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 @@ -58580,7 +50834,8 @@ definitions: 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 @@ -58610,7 +50865,9 @@ definitions: 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 @@ -58639,9 +50896,11 @@ definitions: 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: @@ -58722,7 +50981,9 @@ definitions: 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: @@ -58782,9 +51043,11 @@ definitions: 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 @@ -58830,37 +51093,34 @@ definitions: 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 @@ -58958,10 +51218,12 @@ definitions: 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: @@ -59001,9 +51263,11 @@ definitions: 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: @@ -59040,9 +51304,10 @@ definitions: 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: @@ -59080,8 +51345,9 @@ definitions: 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: @@ -59134,8 +51400,10 @@ definitions: 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: @@ -59161,8 +51429,10 @@ definitions: 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: @@ -59229,14 +51499,17 @@ definitions: 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 @@ -59267,6 +51540,7 @@ definitions: 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 @@ -59310,13 +51584,15 @@ definitions: 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 @@ -59353,7 +51629,9 @@ definitions: 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: @@ -59415,14 +51693,15 @@ definitions: 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 @@ -59513,13 +51792,16 @@ definitions: 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 @@ -59538,6 +51820,7 @@ definitions: 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. @@ -59585,7 +51868,9 @@ definitions: 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: @@ -59615,10 +51900,11 @@ definitions: 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: @@ -59657,10 +51943,11 @@ definitions: 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: @@ -59699,9 +51986,10 @@ definitions: 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 @@ -59731,15 +52019,17 @@ definitions: 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 @@ -59779,11 +52069,13 @@ definitions: 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: @@ -59815,8 +52107,10 @@ definitions: 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 @@ -59855,15 +52149,17 @@ definitions: 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 @@ -59891,8 +52187,10 @@ definitions: 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 @@ -59929,7 +52227,9 @@ definitions: 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 @@ -59951,11 +52251,12 @@ definitions: 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 @@ -60009,11 +52310,12 @@ definitions: 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: @@ -60059,12 +52361,14 @@ definitions: 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 @@ -60112,19 +52416,20 @@ definitions: 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 @@ -60149,8 +52454,10 @@ definitions: 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. @@ -60178,11 +52485,12 @@ definitions: 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 @@ -60220,12 +52528,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -60254,21 +52556,24 @@ patchDefinitions: 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: @@ -60302,15 +52607,18 @@ patchDefinitions: 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 @@ -60371,7 +52679,9 @@ patchDefinitions: 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: @@ -60424,27 +52734,29 @@ patchDefinitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -60476,6 +52788,7 @@ patchDefinitions: 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. @@ -60492,20 +52805,22 @@ patchDefinitions: 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 @@ -60539,19 +52854,21 @@ patchDefinitions: 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 @@ -60612,10 +52929,11 @@ patchDefinitions: 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: @@ -60634,10 +52952,12 @@ patchDefinitions: 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 @@ -60658,8 +52978,10 @@ patchDefinitions: 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: @@ -60677,10 +52999,12 @@ patchDefinitions: 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 @@ -60708,8 +53032,9 @@ patchDefinitions: 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 @@ -60750,8 +53075,9 @@ patchDefinitions: 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 @@ -60820,9 +53146,11 @@ patchDefinitions: 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 @@ -60843,8 +53171,10 @@ patchDefinitions: 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 @@ -60867,8 +53197,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -60885,10 +53216,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -60964,9 +53297,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -60989,8 +53323,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -61013,7 +53348,9 @@ patchDefinitions: 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: @@ -61096,10 +53433,12 @@ patchDefinitions: 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 @@ -61156,12 +53495,14 @@ patchDefinitions: 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: @@ -61176,7 +53517,9 @@ patchDefinitions: 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: @@ -61211,11 +53554,13 @@ patchDefinitions: 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 @@ -61236,44 +53581,41 @@ patchDefinitions: 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: @@ -61377,8 +53719,10 @@ patchDefinitions: 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 @@ -61391,9 +53735,10 @@ patchDefinitions: 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 @@ -61422,7 +53767,9 @@ patchDefinitions: 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 @@ -61458,10 +53805,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -61482,7 +53830,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -61496,11 +53846,13 @@ patchDefinitions: 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 @@ -61562,22 +53914,20 @@ patchDefinitions: 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 @@ -61634,13 +53984,9 @@ patchDefinitions: 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: @@ -61685,9 +54031,10 @@ patchDefinitions: 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: @@ -61770,26 +54117,28 @@ patchDefinitions: 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 @@ -61825,6 +54174,7 @@ patchDefinitions: 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. @@ -61837,12 +54187,14 @@ patchDefinitions: 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: @@ -61868,12 +54220,14 @@ patchDefinitions: 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: @@ -61899,24 +54253,25 @@ patchDefinitions: 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 @@ -61945,6 +54300,7 @@ patchDefinitions: 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 @@ -61962,17 +54318,19 @@ patchDefinitions: 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 @@ -61995,8 +54353,10 @@ patchDefinitions: 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: @@ -62015,8 +54375,10 @@ patchDefinitions: 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 @@ -62039,7 +54401,8 @@ patchDefinitions: 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: @@ -62058,24 +54421,27 @@ patchDefinitions: 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 @@ -62086,6 +54452,7 @@ patchDefinitions: 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 @@ -62121,11 +54488,13 @@ patchDefinitions: 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 @@ -62138,13 +54507,15 @@ patchDefinitions: 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 @@ -62176,9 +54547,11 @@ patchDefinitions: 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 @@ -62201,14 +54574,16 @@ patchDefinitions: 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 @@ -62234,18 +54609,21 @@ patchDefinitions: 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 @@ -62283,7 +54661,8 @@ patchDefinitions: 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 @@ -62316,10 +54695,11 @@ patchDefinitions: 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 @@ -62339,13 +54719,15 @@ patchDefinitions: 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: @@ -62452,8 +54834,9 @@ patchDefinitions: 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: @@ -62470,7 +54853,8 @@ patchDefinitions: 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: @@ -62492,8 +54876,9 @@ patchDefinitions: 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 @@ -62534,6 +54919,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -62589,9 +54980,10 @@ patchDefinitions: 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 @@ -62626,8 +55018,9 @@ patchDefinitions: 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 @@ -62706,7 +55099,8 @@ patchDefinitions: 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 @@ -62721,17 +55115,19 @@ patchDefinitions: 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 @@ -62778,7 +55174,9 @@ patchDefinitions: 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: @@ -62829,7 +55227,8 @@ patchDefinitions: 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: @@ -62848,17 +55247,18 @@ patchDefinitions: 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) + - 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 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 + - 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 @@ -62898,6 +55298,7 @@ patchDefinitions: 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. @@ -62934,9 +55335,11 @@ patchDefinitions: 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 @@ -62963,7 +55366,8 @@ patchDefinitions: 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: @@ -62990,7 +55394,9 @@ patchDefinitions: 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 @@ -63015,19 +55421,20 @@ patchDefinitions: 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 @@ -63097,6 +55504,7 @@ patchDefinitions: 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. @@ -63119,7 +55527,9 @@ patchDefinitions: 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 @@ -63222,7 +55632,8 @@ patchDefinitions: 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 @@ -63245,7 +55656,9 @@ patchDefinitions: 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 @@ -63267,9 +55680,11 @@ patchDefinitions: 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: @@ -63339,7 +55754,9 @@ patchDefinitions: 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: @@ -63382,9 +55799,11 @@ patchDefinitions: 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 @@ -63423,37 +55842,34 @@ patchDefinitions: 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 @@ -63530,10 +55946,12 @@ patchDefinitions: 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: @@ -63562,9 +55980,11 @@ patchDefinitions: 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: @@ -63590,9 +56010,10 @@ patchDefinitions: 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: @@ -63619,8 +56040,9 @@ patchDefinitions: 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: @@ -63666,8 +56088,10 @@ patchDefinitions: 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: @@ -63686,8 +56110,10 @@ patchDefinitions: 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: @@ -63744,14 +56170,17 @@ patchDefinitions: 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 @@ -63782,6 +56211,7 @@ patchDefinitions: 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 @@ -63810,13 +56240,15 @@ patchDefinitions: 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 @@ -63842,7 +56274,9 @@ patchDefinitions: 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: @@ -63897,14 +56331,15 @@ patchDefinitions: 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 @@ -63970,13 +56405,16 @@ patchDefinitions: 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 @@ -63995,6 +56433,7 @@ patchDefinitions: 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 @@ -64007,7 +56446,9 @@ patchDefinitions: 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: @@ -64030,10 +56471,11 @@ patchDefinitions: 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: @@ -64059,10 +56501,11 @@ patchDefinitions: 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: @@ -64088,9 +56531,10 @@ patchDefinitions: 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 @@ -64113,15 +56557,17 @@ patchDefinitions: 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 @@ -64157,8 +56603,10 @@ patchDefinitions: 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 @@ -64190,15 +56638,17 @@ patchDefinitions: 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 @@ -64226,8 +56676,10 @@ patchDefinitions: 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 @@ -64249,7 +56701,9 @@ patchDefinitions: 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 @@ -64264,11 +56718,12 @@ patchDefinitions: 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 @@ -64315,11 +56770,12 @@ patchDefinitions: 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: @@ -64350,12 +56806,14 @@ patchDefinitions: 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 @@ -64391,19 +56849,20 @@ patchDefinitions: 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 @@ -64428,8 +56887,10 @@ patchDefinitions: 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. @@ -64442,11 +56903,12 @@ patchDefinitions: 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 @@ -64477,12 +56939,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -64511,21 +56967,24 @@ getDefinitions: 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: @@ -64582,15 +57041,18 @@ getDefinitions: 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 @@ -64658,7 +57120,9 @@ getDefinitions: 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: @@ -64718,27 +57182,29 @@ getDefinitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -64770,6 +57236,7 @@ getDefinitions: 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. @@ -64842,20 +57309,22 @@ getDefinitions: 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 @@ -64925,19 +57394,21 @@ getDefinitions: 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 @@ -65017,10 +57488,11 @@ getDefinitions: 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: @@ -65065,10 +57537,12 @@ getDefinitions: 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 @@ -65099,8 +57573,10 @@ getDefinitions: 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: @@ -65125,10 +57601,12 @@ getDefinitions: 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 @@ -65163,8 +57641,9 @@ getDefinitions: 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 @@ -65223,8 +57702,9 @@ getDefinitions: 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 @@ -65300,9 +57780,11 @@ getDefinitions: 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 @@ -65333,8 +57815,10 @@ getDefinitions: 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 @@ -65364,8 +57848,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -65391,10 +57876,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -65476,9 +57963,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -65510,8 +57998,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -65543,7 +58032,9 @@ getDefinitions: 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: @@ -65633,10 +58124,12 @@ getDefinitions: 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 @@ -65700,12 +58193,14 @@ getDefinitions: 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: @@ -65727,7 +58222,9 @@ getDefinitions: 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: @@ -65769,11 +58266,13 @@ getDefinitions: 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 @@ -65808,44 +58307,41 @@ getDefinitions: 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: @@ -65949,8 +58445,10 @@ getDefinitions: 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. @@ -66061,9 +58559,10 @@ getDefinitions: 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 @@ -66099,7 +58598,9 @@ getDefinitions: 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 @@ -66142,10 +58643,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -66177,7 +58679,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -66198,11 +58702,13 @@ getDefinitions: 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 @@ -66275,22 +58781,20 @@ getDefinitions: 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 @@ -66354,13 +58858,9 @@ getDefinitions: 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: @@ -66405,9 +58905,10 @@ getDefinitions: 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: @@ -66501,26 +59002,28 @@ getDefinitions: 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 @@ -66556,16 +59059,19 @@ getDefinitions: 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. @@ -66605,12 +59111,14 @@ getDefinitions: 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: @@ -66649,12 +59157,14 @@ getDefinitions: 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: @@ -66693,24 +59203,25 @@ getDefinitions: 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 @@ -66739,6 +59250,7 @@ getDefinitions: 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 @@ -66784,10 +59296,13 @@ getDefinitions: 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. @@ -66821,17 +59336,19 @@ getDefinitions: 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 @@ -66862,6 +59379,7 @@ getDefinitions: 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: @@ -66882,8 +59400,10 @@ getDefinitions: 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: @@ -66909,8 +59429,10 @@ getDefinitions: 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 @@ -66940,7 +59462,8 @@ getDefinitions: 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: @@ -66966,24 +59489,27 @@ getDefinitions: 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 @@ -66994,6 +59520,7 @@ getDefinitions: 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 @@ -67072,11 +59599,13 @@ getDefinitions: 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 @@ -67092,13 +59621,15 @@ getDefinitions: 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 @@ -67141,9 +59672,11 @@ getDefinitions: 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 @@ -67169,14 +59702,16 @@ getDefinitions: 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 @@ -67219,18 +59754,21 @@ getDefinitions: 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 @@ -67283,7 +59821,8 @@ getDefinitions: 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 @@ -67323,10 +59862,11 @@ getDefinitions: 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 @@ -67356,13 +59896,15 @@ getDefinitions: 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: @@ -67491,8 +60033,9 @@ getDefinitions: 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: @@ -67516,7 +60059,8 @@ getDefinitions: 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: @@ -67545,8 +60089,9 @@ getDefinitions: 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 @@ -67610,6 +60155,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -67665,9 +60216,10 @@ getDefinitions: 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 @@ -67709,8 +60261,9 @@ getDefinitions: 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 @@ -67805,7 +60358,8 @@ getDefinitions: 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 @@ -67827,17 +60381,19 @@ getDefinitions: 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 @@ -67877,6 +60433,7 @@ getDefinitions: 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 @@ -67904,7 +60461,9 @@ getDefinitions: 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: @@ -67962,7 +60521,8 @@ getDefinitions: 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: @@ -67988,17 +60548,18 @@ getDefinitions: 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) + - 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 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 + - 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 @@ -68038,6 +60599,7 @@ getDefinitions: 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. @@ -68095,9 +60657,11 @@ getDefinitions: 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 @@ -68153,7 +60717,8 @@ getDefinitions: 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: @@ -68187,7 +60752,9 @@ getDefinitions: 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 @@ -68214,19 +60781,20 @@ getDefinitions: 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 @@ -68296,6 +60864,7 @@ getDefinitions: 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. @@ -68348,7 +60917,9 @@ getDefinitions: 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 @@ -68463,7 +61034,8 @@ getDefinitions: 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 @@ -68493,7 +61065,9 @@ getDefinitions: 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 @@ -68522,9 +61096,11 @@ getDefinitions: 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: @@ -68605,7 +61181,9 @@ getDefinitions: 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: @@ -68665,9 +61243,11 @@ getDefinitions: 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 @@ -68713,37 +61293,34 @@ getDefinitions: 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 @@ -68841,10 +61418,12 @@ getDefinitions: 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: @@ -68884,9 +61463,11 @@ getDefinitions: 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: @@ -68923,9 +61504,10 @@ getDefinitions: 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: @@ -68963,8 +61545,9 @@ getDefinitions: 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: @@ -69017,8 +61600,10 @@ getDefinitions: 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: @@ -69044,8 +61629,10 @@ getDefinitions: 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: @@ -69112,14 +61699,17 @@ getDefinitions: 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 @@ -69150,6 +61740,7 @@ getDefinitions: 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 @@ -69193,13 +61784,15 @@ getDefinitions: 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 @@ -69236,7 +61829,9 @@ getDefinitions: 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: @@ -69298,14 +61893,15 @@ getDefinitions: 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 @@ -69396,13 +61992,16 @@ getDefinitions: 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 @@ -69421,6 +62020,7 @@ getDefinitions: 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. @@ -69468,7 +62068,9 @@ getDefinitions: 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: @@ -69498,10 +62100,11 @@ getDefinitions: 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: @@ -69540,10 +62143,11 @@ getDefinitions: 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: @@ -69582,9 +62186,10 @@ getDefinitions: 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 @@ -69614,15 +62219,17 @@ getDefinitions: 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 @@ -69662,11 +62269,13 @@ getDefinitions: 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: @@ -69698,8 +62307,10 @@ getDefinitions: 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 @@ -69738,15 +62349,17 @@ getDefinitions: 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 @@ -69774,8 +62387,10 @@ getDefinitions: 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 @@ -69812,7 +62427,9 @@ getDefinitions: 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 @@ -69834,11 +62451,12 @@ getDefinitions: 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 @@ -69892,11 +62510,12 @@ getDefinitions: 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: @@ -69942,12 +62561,14 @@ getDefinitions: 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 @@ -69995,19 +62616,20 @@ getDefinitions: 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 @@ -70032,8 +62654,10 @@ getDefinitions: 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. @@ -70061,11 +62685,12 @@ getDefinitions: 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 diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml index 976f1aa9..3359bf46 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 @@ -756,7 +712,7 @@ paths: 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" @@ -829,214 +785,32 @@ paths: 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 @@ -1079,27 +853,16 @@ paths: 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 @@ -1140,25 +903,21 @@ paths: 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: @@ -1192,26 +951,22 @@ paths: 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: @@ -1239,55 +994,35 @@ paths: 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 @@ -1322,18 +1057,24 @@ paths: 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 @@ -1368,19 +1109,32 @@ paths: 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: @@ -1408,21 +1162,54 @@ paths: 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" @@ -1431,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1466,24 +1253,12 @@ paths: 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 @@ -1530,15 +1305,9 @@ paths: 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" @@ -1547,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1594,27 +1363,19 @@ paths: 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: @@ -1660,91 +1421,130 @@ paths: 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 @@ -1883,7 +1683,7 @@ paths: 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" @@ -2132,91 +1932,6 @@ paths: 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 @@ -2355,7 +2070,7 @@ paths: 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" @@ -2476,75 +2191,6 @@ paths: 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 @@ -2671,7 +2317,7 @@ paths: 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" @@ -2780,62 +2426,20 @@ paths: 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: @@ -3002,84 +2606,6 @@ paths: 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 @@ -3206,7 +2732,7 @@ paths: 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" @@ -3315,62 +2841,29 @@ paths: 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: @@ -3635,80 +3128,6 @@ paths: 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 @@ -3835,7 +3254,7 @@ paths: 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" @@ -4060,80 +3479,6 @@ paths: 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 @@ -4260,7 +3605,7 @@ paths: 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" @@ -4369,64 +3714,6 @@ paths: 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 @@ -4541,7 +3828,7 @@ paths: 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" @@ -4638,49 +3925,26 @@ paths: 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: @@ -4723,49 +3987,6 @@ paths: 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 @@ -4868,7 +4089,7 @@ paths: 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" @@ -4953,26 +4174,36 @@ paths: 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: @@ -5083,26 +4314,6 @@ paths: 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 @@ -5193,7 +4404,7 @@ paths: 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" @@ -5266,14 +4477,19 @@ paths: 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: + required: false + type: string + - name: tenant-context in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: @@ -5508,31 +4724,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5647,7 +4838,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -5744,31 +4935,6 @@ paths: 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5871,7 +5037,7 @@ paths: 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" @@ -5956,19 +5122,19 @@ paths: required: true type: string example: __FLAVOR-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: 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: @@ -6081,21 +5247,6 @@ paths: 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 @@ -6186,7 +5337,7 @@ paths: 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" @@ -6259,14 +5410,14 @@ paths: 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: @@ -6379,26 +5530,6 @@ paths: 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 @@ -6489,7 +5620,7 @@ paths: 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" @@ -6562,14 +5693,19 @@ paths: 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: @@ -6682,41 +5818,6 @@ paths: 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 @@ -6807,7 +5908,7 @@ paths: 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" @@ -6880,14 +5981,34 @@ paths: 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: @@ -7005,36 +6126,6 @@ paths: 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 @@ -7135,7 +6226,7 @@ paths: 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" @@ -7219,34 +6310,9 @@ paths: 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}: @@ -7285,36 +6351,6 @@ paths: 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 @@ -7405,7 +6441,7 @@ paths: 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" @@ -7478,14 +6514,29 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -7598,21 +6649,6 @@ paths: 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 @@ -7703,7 +6739,7 @@ paths: 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" @@ -7776,14 +6812,14 @@ paths: 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: @@ -7896,27 +6932,6 @@ paths: 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 @@ -8007,7 +7022,7 @@ paths: 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" @@ -8080,16 +7095,22 @@ paths: 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: @@ -8200,16 +7221,6 @@ paths: 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 @@ -8300,7 +7311,7 @@ paths: 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" @@ -8373,14 +7384,9 @@ paths: 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: @@ -8555,32 +7561,6 @@ paths: 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 @@ -8671,7 +7651,7 @@ paths: 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" @@ -8824,32 +7804,6 @@ paths: 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 @@ -8940,7 +7894,7 @@ paths: 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" @@ -9185,26 +8139,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9307,7 +8241,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -9392,26 +8326,6 @@ paths: 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: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9502,7 +8416,7 @@ paths: 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" @@ -9575,14 +8489,19 @@ paths: 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}: @@ -9615,16 +8534,6 @@ paths: 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 @@ -9703,7 +8612,7 @@ paths: 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" @@ -9757,6 +8666,27 @@ paths: $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: @@ -9897,7 +8827,7 @@ paths: 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" @@ -9945,6 +8875,12 @@ paths: $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: @@ -10167,30 +9103,6 @@ paths: 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 @@ -10281,7 +9193,7 @@ paths: 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" @@ -10354,28 +9266,9 @@ paths: 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: @@ -10610,72 +9503,6 @@ paths: 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 @@ -10790,7 +9617,7 @@ paths: 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" @@ -10991,196 +9818,130 @@ paths: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - 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/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11268,56 +10029,6 @@ paths: 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 @@ -11420,7 +10131,7 @@ paths: 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" @@ -11505,43 +10216,20 @@ paths: 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: @@ -11672,65 +10360,6 @@ paths: 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: 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: - CloudInfrastructure @@ -11833,7 +10462,7 @@ paths: 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" @@ -11918,43 +10547,29 @@ paths: 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: @@ -12159,61 +10774,6 @@ paths: 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 @@ -12316,7 +10876,7 @@ paths: 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" @@ -12493,61 +11053,6 @@ paths: 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 @@ -12650,7 +11155,7 @@ paths: 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" @@ -12735,45 +11240,6 @@ paths: 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 @@ -12864,7 +11330,7 @@ paths: 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" @@ -12937,28 +11403,24 @@ paths: 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}: @@ -12991,30 +11453,6 @@ paths: 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 @@ -13093,7 +11531,7 @@ paths: 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" @@ -13154,23 +11592,14 @@ paths: 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: @@ -13467,77 +11896,6 @@ paths: 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 @@ -13652,7 +12010,7 @@ paths: 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" @@ -13853,77 +12211,6 @@ paths: 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 @@ -14038,7 +12325,7 @@ paths: 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" @@ -14135,61 +12422,6 @@ paths: 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 @@ -14292,7 +12524,7 @@ paths: 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" @@ -14377,48 +12609,20 @@ paths: 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: @@ -14549,70 +12753,6 @@ paths: 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 @@ -14715,7 +12855,7 @@ paths: 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" @@ -14800,48 +12940,29 @@ paths: 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: @@ -15046,66 +13167,6 @@ paths: 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 @@ -15208,7 +13269,7 @@ paths: 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" @@ -15385,66 +13446,6 @@ paths: 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 @@ -15547,7 +13548,7 @@ paths: 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" @@ -15632,50 +13633,6 @@ paths: 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 @@ -15766,7 +13723,7 @@ paths: 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" @@ -15839,33 +13796,24 @@ paths: 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}: @@ -15898,35 +13846,6 @@ paths: 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 @@ -16005,7 +13924,7 @@ paths: 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" @@ -16066,23 +13985,19 @@ paths: 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}: @@ -16109,25 +14024,6 @@ paths: 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 @@ -16194,7 +14090,7 @@ paths: 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" @@ -16242,6 +14138,32 @@ paths: $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: @@ -16316,11 +14238,6 @@ paths: 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 @@ -16387,7 +14304,7 @@ paths: 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" @@ -16435,6 +14352,17 @@ paths: $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: @@ -16575,7 +14503,7 @@ paths: 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" @@ -16623,6 +14551,12 @@ paths: $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: @@ -16702,26 +14636,6 @@ paths: 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 @@ -16798,7 +14712,7 @@ paths: 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" @@ -16858,24 +14772,9 @@ paths: 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}: @@ -16902,26 +14801,6 @@ paths: 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 @@ -16988,7 +14867,7 @@ paths: 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" @@ -17036,185 +14915,156 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: - put: - tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - 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__ - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: - get: - tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/metadatum" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: 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: 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: resource-instance-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. + 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. - 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}/relationship-list/relationship: 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 + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - 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__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: 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__ + 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 @@ -17306,7 +15156,7 @@ paths: 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" @@ -17390,59 +15240,9 @@ paths: 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 + - name: metaname 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: @@ -17591,81 +15391,6 @@ paths: 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 @@ -17780,7 +15505,7 @@ paths: 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" @@ -17877,79 +15602,9 @@ paths: 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: @@ -18080,81 +15735,6 @@ paths: 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 @@ -18257,7 +15837,7 @@ paths: 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" @@ -18342,59 +15922,29 @@ paths: 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. - 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. + description: 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}: @@ -18433,61 +15983,6 @@ paths: 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 @@ -18578,7 +16073,7 @@ paths: 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" @@ -18651,14 +16146,54 @@ paths: 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: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -18753,16 +16288,6 @@ paths: 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 @@ -18841,7 +16366,7 @@ paths: 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" @@ -18902,14 +16427,9 @@ paths: 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: @@ -18986,16 +16506,6 @@ paths: 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 @@ -19062,7 +16572,7 @@ paths: 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" @@ -19110,6 +16620,22 @@ paths: $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: @@ -19250,7 +16776,7 @@ paths: 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" @@ -19298,6 +16824,12 @@ paths: $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: @@ -19438,7 +16970,7 @@ paths: 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" @@ -19486,6 +17018,12 @@ paths: $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: @@ -19626,7 +17164,7 @@ paths: 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" @@ -19674,6 +17212,12 @@ paths: $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: @@ -19814,7 +17358,7 @@ paths: 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" @@ -19862,6 +17406,12 @@ paths: $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: @@ -19936,21 +17486,6 @@ paths: 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 @@ -20017,7 +17552,7 @@ paths: 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" @@ -20065,6 +17600,27 @@ paths: $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: @@ -20139,11 +17695,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20210,7 +17761,7 @@ paths: 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" @@ -20258,6 +17809,17 @@ paths: $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: @@ -20428,7 +17990,7 @@ paths: 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" @@ -20482,6 +18044,17 @@ paths: $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: @@ -20634,26 +18207,6 @@ paths: 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 @@ -20772,7 +18325,7 @@ paths: 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" @@ -20874,24 +18427,9 @@ paths: 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: @@ -21031,26 +18569,6 @@ paths: 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 @@ -21159,7 +18677,7 @@ paths: 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" @@ -21251,24 +18769,9 @@ paths: 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}: @@ -21311,232 +18814,197 @@ paths: 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 + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true type: string - - name: model-version + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/model-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: resource-version in: query - description: Version - required: false + description: resource-version for concurrency + required: true type: string - - name: distribution-status + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: 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: put: tags: - ServiceDesignAndCreation - summary: create or update an existing model-constraint - description: | - Create or update an existing model-constraint. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) - required: true - schema: - $ref: "#/definitions/model-constraint" - patch: - tags: - - ServiceDesignAndCreation - summary: update an existing model-constraint - description: | - Update an existing model-constraint - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/model-constraint" - delete: - tags: - - ServiceDesignAndCreation - summary: delete an existing model-constraint - description: delete an existing model-constraint - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: - get: - tags: - - ServiceDesignAndCreation - summary: returns model-constraints - description: returns model-constraints - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/model-constraints" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-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 - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: - put: - tags: - - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship consumes: - application/json - application/xml @@ -21638,26 +19106,6 @@ paths: 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 @@ -21746,7 +19194,7 @@ paths: 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" @@ -21818,24 +19266,9 @@ paths: 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}: @@ -21873,26 +19306,6 @@ paths: 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 @@ -21981,7 +19394,7 @@ paths: 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" @@ -22053,24 +19466,9 @@ paths: 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: @@ -22165,26 +19563,6 @@ paths: 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 @@ -22263,7 +19641,7 @@ paths: 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" @@ -22324,9 +19702,24 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type + - name: model-version-id in: query - description: Type of the model, e.g., service, resource, widget, etc. + 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: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -22403,11 +19796,6 @@ paths: 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 @@ -22474,7 +19862,7 @@ paths: 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" @@ -22522,6 +19910,17 @@ paths: $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: @@ -22623,10 +20022,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22711,7 +20106,7 @@ paths: 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" @@ -22779,8 +20174,9 @@ paths: 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}: @@ -22816,10 +20212,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22904,7 +20296,7 @@ paths: 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" @@ -22972,8 +20364,9 @@ paths: 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: @@ -23062,10 +20455,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23140,7 +20529,7 @@ paths: 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" @@ -23198,8 +20587,9 @@ paths: 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: @@ -23273,10 +20663,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23341,7 +20727,7 @@ paths: 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" @@ -23388,6 +20774,17 @@ paths: $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: @@ -23462,46 +20859,6 @@ paths: 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 @@ -23568,7 +20925,7 @@ paths: 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" @@ -23616,6 +20973,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: 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: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - 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: @@ -23846,7 +21249,7 @@ paths: 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" @@ -23931,6 +21334,11 @@ paths: 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: @@ -24131,7 +21539,7 @@ paths: 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" @@ -24204,6 +21612,11 @@ paths: 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: @@ -24374,7 +21787,7 @@ paths: 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" @@ -24435,6 +21848,11 @@ paths: 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: @@ -24575,7 +21993,7 @@ paths: 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" @@ -24623,135 +22041,131 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: - get: - tags: - - Network - summary: returns route-target - description: returns route-target - operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/route-target" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type + - name: site-pair-set-id in: query - description: Type of the vpn, should be taken from enumerated/valid values + 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: - Network - summary: create or update an existing route-target - description: | - Create or update an existing route-target. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: + tags: + - Network + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + put: + tags: + - Network + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -24833,7 +22247,7 @@ paths: 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" @@ -24900,16 +22314,6 @@ paths: 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: @@ -24984,16 +22388,6 @@ paths: 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 @@ -25060,7 +22454,7 @@ paths: 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" @@ -25108,6 +22502,22 @@ paths: $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: @@ -25323,16 +22733,6 @@ paths: 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 @@ -25421,7 +22821,7 @@ paths: 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" @@ -25492,14 +22892,9 @@ paths: 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: @@ -25729,58 +23124,6 @@ paths: 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 @@ -25893,7 +23236,7 @@ paths: 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" @@ -26090,58 +23433,6 @@ paths: 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 @@ -26254,7 +23545,7 @@ paths: 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" @@ -26349,42 +23640,6 @@ paths: 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 @@ -26485,7 +23740,7 @@ paths: 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" @@ -26568,29 +23823,20 @@ paths: 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: @@ -26718,51 +23964,6 @@ paths: 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 @@ -26863,7 +24064,7 @@ paths: 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" @@ -26946,29 +24147,29 @@ paths: 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: @@ -27168,47 +24369,6 @@ paths: 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 @@ -27309,7 +24469,7 @@ paths: 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" @@ -27482,47 +24642,6 @@ paths: 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 @@ -27623,7 +24742,7 @@ paths: 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" @@ -27706,31 +24825,6 @@ paths: 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 @@ -27819,7 +24913,7 @@ paths: 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" @@ -27890,14 +24984,24 @@ paths: 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}: @@ -27929,16 +25033,6 @@ paths: 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 @@ -28015,7 +25109,7 @@ paths: 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" @@ -28074,9 +25168,14 @@ paths: 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: @@ -28366,63 +25465,6 @@ paths: 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 @@ -28535,7 +25577,7 @@ paths: 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" @@ -28732,63 +25774,6 @@ paths: 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 @@ -28901,7 +25886,7 @@ paths: 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" @@ -28996,47 +25981,6 @@ paths: 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 @@ -29137,7 +26081,7 @@ paths: 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" @@ -29220,34 +26164,20 @@ paths: 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: @@ -29375,56 +26305,6 @@ paths: 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 @@ -29525,7 +26405,7 @@ paths: 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" @@ -29608,34 +26488,29 @@ paths: 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: @@ -29835,52 +26710,6 @@ paths: 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 @@ -29981,7 +26810,7 @@ paths: 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" @@ -30154,162 +26983,116 @@ paths: 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 @@ -30383,36 +27166,6 @@ paths: 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 @@ -30501,7 +27254,7 @@ paths: 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" @@ -30572,19 +27325,24 @@ paths: 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}: @@ -30616,21 +27374,6 @@ paths: 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 @@ -30707,7 +27450,7 @@ paths: 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" @@ -30766,9 +27509,19 @@ paths: 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}: @@ -30794,11 +27547,6 @@ paths: 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 @@ -30863,7 +27611,7 @@ paths: 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" @@ -30910,6 +27658,17 @@ paths: $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: @@ -31050,7 +27809,7 @@ paths: 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" @@ -31098,6 +27857,12 @@ paths: $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: @@ -31211,61 +27976,6 @@ paths: 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 @@ -31358,7 +28068,7 @@ paths: 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" @@ -31432,61 +28142,12 @@ paths: 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: @@ -31579,61 +28240,6 @@ paths: 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 @@ -31712,7 +28318,7 @@ paths: 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" @@ -31773,44 +28379,24 @@ paths: 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: @@ -31923,46 +28509,6 @@ paths: 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 @@ -32053,7 +28599,7 @@ paths: 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" @@ -32120,44 +28666,14 @@ paths: 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: @@ -32270,46 +28786,6 @@ paths: 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 @@ -32400,7 +28876,7 @@ paths: 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" @@ -32467,44 +28943,14 @@ paths: 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: @@ -32581,46 +29027,6 @@ paths: 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 @@ -32687,7 +29093,7 @@ paths: 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" @@ -32735,6 +29141,52 @@ paths: $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: @@ -32877,65 +29329,6 @@ paths: 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 @@ -33014,7 +29407,7 @@ paths: 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" @@ -33143,65 +29536,6 @@ paths: 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 @@ -33280,7 +29614,7 @@ paths: 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" @@ -33341,49 +29675,6 @@ paths: 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 @@ -33450,7 +29741,7 @@ paths: 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" @@ -33498,6 +29789,57 @@ paths: $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: @@ -33608,56 +29950,6 @@ paths: 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 @@ -33748,7 +30040,7 @@ paths: 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" @@ -33821,54 +30113,9 @@ paths: 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: @@ -33963,56 +30210,6 @@ paths: 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 @@ -34091,7 +30288,7 @@ paths: 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" @@ -34152,49 +30349,14 @@ paths: 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: @@ -34292,51 +30454,6 @@ paths: 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 @@ -34417,7 +30534,7 @@ paths: 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" @@ -34479,51 +30596,12 @@ paths: 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: @@ -34616,51 +30694,6 @@ paths: 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 @@ -34739,7 +30772,7 @@ paths: 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" @@ -34800,49 +30833,9 @@ paths: 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: @@ -34919,51 +30912,6 @@ paths: 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 @@ -35030,7 +30978,7 @@ paths: 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" @@ -35078,6 +31026,57 @@ paths: $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: @@ -35152,11 +31151,6 @@ paths: 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 @@ -35223,7 +31217,7 @@ paths: 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" @@ -35271,6 +31265,17 @@ paths: $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: @@ -35523,131 +31528,6 @@ paths: 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 @@ -35750,7 +31630,7 @@ paths: 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" @@ -35927,131 +31807,6 @@ paths: 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 @@ -36154,7 +31909,7 @@ paths: 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" @@ -36239,115 +31994,6 @@ paths: 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 @@ -36438,7 +32084,7 @@ paths: 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" @@ -36511,102 +32157,20 @@ paths: 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: @@ -36719,124 +32283,6 @@ paths: 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 @@ -36927,7 +32373,7 @@ paths: 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" @@ -37000,102 +32446,29 @@ paths: 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: @@ -37270,120 +32643,6 @@ paths: 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 @@ -37474,7 +32733,7 @@ paths: 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" @@ -37627,120 +32886,6 @@ paths: 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 @@ -37831,7 +32976,7 @@ paths: 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" @@ -37904,104 +33049,6 @@ paths: 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 @@ -38080,7 +33127,7 @@ paths: 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" @@ -38141,87 +33188,24 @@ paths: 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: @@ -38518,141 +33502,6 @@ paths: 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 @@ -38767,7 +33616,7 @@ paths: 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" @@ -38968,141 +33817,6 @@ paths: 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 @@ -39217,7 +33931,7 @@ paths: 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" @@ -39314,125 +34028,6 @@ paths: 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 @@ -39535,7 +34130,7 @@ paths: 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" @@ -39620,112 +34215,20 @@ paths: 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: @@ -39856,134 +34359,6 @@ paths: 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 @@ -40086,7 +34461,7 @@ paths: 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" @@ -40171,112 +34546,29 @@ paths: 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: @@ -40481,159 +34773,35 @@ paths: 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 @@ -40707,7 +34875,7 @@ paths: 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" @@ -40884,130 +35052,6 @@ paths: 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 @@ -41110,7 +35154,7 @@ paths: 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" @@ -41195,114 +35239,6 @@ paths: 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 @@ -41393,7 +35329,7 @@ paths: 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" @@ -41466,97 +35402,24 @@ paths: 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}: @@ -41589,99 +35452,6 @@ paths: 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 @@ -41760,7 +35530,7 @@ paths: 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" @@ -41821,87 +35591,19 @@ paths: 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: @@ -41996,124 +35698,6 @@ paths: 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 @@ -42192,7 +35776,7 @@ paths: 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" @@ -42253,87 +35837,44 @@ paths: 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: @@ -42446,89 +35987,6 @@ paths: 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 @@ -42619,7 +36077,7 @@ paths: 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" @@ -42686,87 +36144,14 @@ paths: 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: @@ -42879,89 +36264,6 @@ paths: 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 @@ -43052,7 +36354,7 @@ paths: 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" @@ -43119,87 +36421,14 @@ paths: 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}: @@ -43226,89 +36455,6 @@ paths: 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 @@ -43375,7 +36521,7 @@ paths: 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" @@ -43423,6 +36569,97 @@ paths: $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: @@ -43563,7 +36800,7 @@ paths: 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" @@ -43611,6 +36848,12 @@ paths: $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: @@ -43863,73 +37106,6 @@ paths: 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 @@ -44032,7 +37208,7 @@ paths: 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" @@ -44209,73 +37385,6 @@ paths: 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 @@ -44378,7 +37487,7 @@ paths: 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" @@ -44463,57 +37572,6 @@ paths: 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 @@ -44604,7 +37662,7 @@ paths: 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" @@ -44677,44 +37735,20 @@ paths: 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: @@ -44751,142 +37785,82 @@ paths: 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 @@ -44977,7 +37951,7 @@ paths: 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" @@ -45050,44 +38024,29 @@ paths: 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: @@ -45262,62 +38221,6 @@ paths: 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 @@ -45408,7 +38311,7 @@ paths: 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" @@ -45561,62 +38464,6 @@ paths: 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 @@ -45707,7 +38554,7 @@ paths: 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" @@ -45780,46 +38627,6 @@ paths: 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 @@ -45898,7 +38705,7 @@ paths: 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" @@ -45959,29 +38766,24 @@ paths: 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}: @@ -46008,31 +38810,6 @@ paths: 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 @@ -46099,7 +38876,7 @@ paths: 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" @@ -46147,6 +38924,37 @@ paths: $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: @@ -46369,16 +39177,6 @@ paths: 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 @@ -46469,7 +39267,7 @@ paths: 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" @@ -46542,14 +39340,9 @@ paths: 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: @@ -46784,58 +39577,6 @@ paths: 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 @@ -46950,7 +39691,7 @@ paths: 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" @@ -47151,58 +39892,6 @@ paths: 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 @@ -47317,7 +40006,7 @@ paths: 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" @@ -47414,42 +40103,6 @@ paths: 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 @@ -47552,7 +40205,7 @@ paths: 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" @@ -47637,29 +40290,20 @@ paths: 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: @@ -47790,51 +40434,6 @@ paths: 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 @@ -47937,7 +40536,7 @@ paths: 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" @@ -48022,29 +40621,29 @@ paths: 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: @@ -48249,47 +40848,6 @@ paths: 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 @@ -48392,7 +40950,7 @@ paths: 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" @@ -48569,47 +41127,6 @@ paths: 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 @@ -48712,7 +41229,7 @@ paths: 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" @@ -48797,31 +41314,6 @@ paths: 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 @@ -48912,7 +41404,7 @@ paths: 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" @@ -48985,14 +41477,24 @@ paths: 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}: @@ -49025,16 +41527,6 @@ paths: 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 @@ -49113,7 +41605,7 @@ paths: 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" @@ -49174,9 +41666,14 @@ paths: 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: @@ -49473,63 +41970,6 @@ paths: 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 @@ -49644,7 +42084,7 @@ paths: 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" @@ -49845,63 +42285,6 @@ paths: 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 @@ -50016,7 +42399,7 @@ paths: 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" @@ -50113,47 +42496,6 @@ paths: 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 @@ -50256,7 +42598,7 @@ paths: 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" @@ -50341,34 +42683,20 @@ paths: 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: @@ -50457,98 +42785,48 @@ paths: 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 @@ -50651,7 +42929,7 @@ paths: 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" @@ -50736,34 +43014,29 @@ paths: 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: @@ -50968,52 +43241,6 @@ paths: 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 @@ -51116,7 +43343,7 @@ paths: 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" @@ -51293,52 +43520,6 @@ paths: 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 @@ -51441,7 +43622,7 @@ paths: 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" @@ -51526,36 +43707,6 @@ paths: 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 @@ -51646,7 +43797,7 @@ paths: 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" @@ -51719,19 +43870,24 @@ paths: 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}: @@ -51764,21 +43920,6 @@ paths: 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 @@ -51857,7 +43998,7 @@ paths: 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" @@ -51918,9 +44059,19 @@ paths: 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}: @@ -51947,11 +44098,6 @@ paths: 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 @@ -52018,7 +44164,7 @@ paths: 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" @@ -52066,6 +44212,17 @@ paths: $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: @@ -52140,11 +44297,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -52211,7 +44363,7 @@ paths: 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" @@ -52259,6 +44411,17 @@ paths: $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: @@ -52479,7 +44642,7 @@ paths: 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" @@ -52540,6 +44703,11 @@ paths: 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: @@ -52630,7 +44798,7 @@ paths: 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" @@ -52678,6 +44846,12 @@ paths: $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: @@ -52752,11 +44926,6 @@ paths: 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 @@ -52823,7 +44992,7 @@ paths: 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" @@ -52871,6 +45040,17 @@ paths: $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: @@ -52945,21 +45125,6 @@ paths: 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 @@ -53026,7 +45191,7 @@ paths: 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" @@ -53074,6 +45239,27 @@ paths: $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: @@ -53148,16 +45334,6 @@ paths: 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 @@ -53224,7 +45400,7 @@ paths: 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" @@ -53272,6 +45448,22 @@ paths: $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: @@ -53351,16 +45543,6 @@ paths: 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 @@ -53437,7 +45619,7 @@ paths: 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" @@ -53497,14 +45679,9 @@ paths: 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: @@ -53599,16 +45776,6 @@ paths: 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 @@ -53687,7 +45854,7 @@ paths: 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" @@ -53748,16 +45915,6 @@ paths: 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: @@ -53850,16 +46007,6 @@ paths: 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 @@ -53938,7 +46085,7 @@ paths: 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" @@ -53999,16 +46146,6 @@ paths: 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: @@ -54033,16 +46170,6 @@ paths: 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 @@ -54109,7 +46236,7 @@ paths: 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" @@ -54157,6 +46284,22 @@ paths: $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: @@ -54302,11 +46445,6 @@ paths: type: integer format: int32 example: __SEQUENCE__ - - name: forwarding-path-name - in: query - description: Name of the FP - required: false - type: string put: tags: - Network @@ -54387,7 +46525,7 @@ paths: 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" @@ -54449,11 +46587,12 @@ paths: 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: @@ -54478,11 +46617,6 @@ paths: 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 @@ -54549,7 +46683,7 @@ paths: 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" @@ -54597,13 +46731,18 @@ paths: $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: @@ -54632,21 +46771,24 @@ definitions: 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: @@ -54703,15 +46845,18 @@ definitions: 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 @@ -54779,7 +46924,9 @@ definitions: 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: @@ -54839,27 +46986,29 @@ definitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -54891,6 +47040,7 @@ definitions: 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. @@ -54963,20 +47113,22 @@ definitions: 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 @@ -55046,19 +47198,21 @@ definitions: 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 @@ -55138,10 +47292,11 @@ definitions: 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: @@ -55186,10 +47341,12 @@ definitions: 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 @@ -55220,8 +47377,10 @@ definitions: 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: @@ -55246,10 +47405,12 @@ definitions: 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 @@ -55284,8 +47445,9 @@ definitions: 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 @@ -55344,8 +47506,9 @@ definitions: 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 @@ -55421,9 +47584,11 @@ definitions: 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 @@ -55454,8 +47619,10 @@ definitions: 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 @@ -55485,8 +47652,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -55512,10 +47680,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -55597,9 +47767,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -55631,8 +47802,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -55664,7 +47836,9 @@ definitions: 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: @@ -55754,10 +47928,12 @@ definitions: 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 @@ -55821,12 +47997,14 @@ definitions: 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: @@ -55848,7 +48026,9 @@ definitions: 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: @@ -55890,11 +48070,13 @@ definitions: 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 @@ -55929,44 +48111,41 @@ definitions: 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: @@ -56070,8 +48249,10 @@ definitions: 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. @@ -56182,9 +48363,10 @@ definitions: 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 @@ -56220,7 +48402,9 @@ definitions: 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 @@ -56263,10 +48447,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -56298,7 +48483,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -56319,11 +48506,13 @@ definitions: 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 @@ -56396,22 +48585,20 @@ definitions: 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 @@ -56475,13 +48662,9 @@ definitions: 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: @@ -56526,9 +48709,10 @@ definitions: 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: @@ -56622,26 +48806,28 @@ definitions: 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 @@ -56677,16 +48863,19 @@ definitions: 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. @@ -56726,12 +48915,14 @@ definitions: 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: @@ -56770,12 +48961,14 @@ definitions: 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: @@ -56814,24 +49007,25 @@ definitions: 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 @@ -56860,6 +49054,7 @@ definitions: 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 @@ -56905,10 +49100,13 @@ definitions: 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. @@ -56942,17 +49140,19 @@ definitions: 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 @@ -56983,6 +49183,7 @@ definitions: 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: @@ -57003,8 +49204,10 @@ definitions: 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: @@ -57030,8 +49233,10 @@ definitions: 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 @@ -57061,7 +49266,8 @@ definitions: 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: @@ -57087,24 +49293,27 @@ definitions: 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 @@ -57115,6 +49324,7 @@ definitions: 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 @@ -57193,11 +49403,13 @@ definitions: 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 @@ -57213,13 +49425,15 @@ definitions: 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 @@ -57262,9 +49476,11 @@ definitions: 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 @@ -57290,14 +49506,16 @@ definitions: 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 @@ -57340,18 +49558,21 @@ definitions: 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 @@ -57404,7 +49625,8 @@ definitions: 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 @@ -57444,10 +49666,11 @@ definitions: 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 @@ -57477,13 +49700,15 @@ definitions: 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: @@ -57612,8 +49837,9 @@ definitions: 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: @@ -57637,7 +49863,8 @@ definitions: 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: @@ -57666,8 +49893,9 @@ definitions: 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 @@ -57731,6 +49959,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -57786,9 +50020,10 @@ definitions: 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 @@ -57830,8 +50065,9 @@ definitions: 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 @@ -57926,7 +50162,8 @@ definitions: 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 @@ -57948,17 +50185,19 @@ definitions: 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 @@ -57998,6 +50237,7 @@ definitions: 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 @@ -58025,7 +50265,9 @@ definitions: 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: @@ -58083,7 +50325,8 @@ definitions: 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: @@ -58109,17 +50352,18 @@ definitions: 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) + - 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 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 + - 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 @@ -58159,6 +50403,7 @@ definitions: 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. @@ -58216,9 +50461,11 @@ definitions: 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 @@ -58274,7 +50521,8 @@ definitions: 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: @@ -58308,7 +50556,9 @@ definitions: 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 @@ -58335,19 +50585,20 @@ definitions: 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 @@ -58417,6 +50668,7 @@ definitions: 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. @@ -58469,7 +50721,9 @@ definitions: 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 @@ -58580,7 +50834,8 @@ definitions: 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 @@ -58610,7 +50865,9 @@ definitions: 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 @@ -58639,9 +50896,11 @@ definitions: 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: @@ -58722,7 +50981,9 @@ definitions: 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: @@ -58782,9 +51043,11 @@ definitions: 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 @@ -58830,37 +51093,34 @@ definitions: 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 @@ -58958,10 +51218,12 @@ definitions: 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: @@ -59001,9 +51263,11 @@ definitions: 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: @@ -59040,9 +51304,10 @@ definitions: 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: @@ -59080,8 +51345,9 @@ definitions: 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: @@ -59134,8 +51400,10 @@ definitions: 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: @@ -59161,8 +51429,10 @@ definitions: 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: @@ -59229,14 +51499,17 @@ definitions: 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 @@ -59267,6 +51540,7 @@ definitions: 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 @@ -59310,13 +51584,15 @@ definitions: 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 @@ -59353,7 +51629,9 @@ definitions: 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: @@ -59415,14 +51693,15 @@ definitions: 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 @@ -59513,13 +51792,16 @@ definitions: 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 @@ -59538,6 +51820,7 @@ definitions: 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. @@ -59585,7 +51868,9 @@ definitions: 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: @@ -59615,10 +51900,11 @@ definitions: 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: @@ -59657,10 +51943,11 @@ definitions: 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: @@ -59699,9 +51986,10 @@ definitions: 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 @@ -59731,15 +52019,17 @@ definitions: 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 @@ -59779,11 +52069,13 @@ definitions: 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: @@ -59815,8 +52107,10 @@ definitions: 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 @@ -59855,15 +52149,17 @@ definitions: 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 @@ -59891,8 +52187,10 @@ definitions: 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 @@ -59929,7 +52227,9 @@ definitions: 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 @@ -59951,11 +52251,12 @@ definitions: 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 @@ -60009,11 +52310,12 @@ definitions: 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: @@ -60059,12 +52361,14 @@ definitions: 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 @@ -60112,19 +52416,20 @@ definitions: 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 @@ -60149,8 +52454,10 @@ definitions: 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. @@ -60178,11 +52485,12 @@ definitions: 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 @@ -60220,12 +52528,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -60254,21 +52556,24 @@ patchDefinitions: 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: @@ -60302,15 +52607,18 @@ patchDefinitions: 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 @@ -60371,7 +52679,9 @@ patchDefinitions: 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: @@ -60424,27 +52734,29 @@ patchDefinitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -60476,6 +52788,7 @@ patchDefinitions: 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. @@ -60492,20 +52805,22 @@ patchDefinitions: 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 @@ -60539,19 +52854,21 @@ patchDefinitions: 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 @@ -60612,10 +52929,11 @@ patchDefinitions: 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: @@ -60634,10 +52952,12 @@ patchDefinitions: 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 @@ -60658,8 +52978,10 @@ patchDefinitions: 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: @@ -60677,10 +52999,12 @@ patchDefinitions: 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 @@ -60708,8 +53032,9 @@ patchDefinitions: 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 @@ -60750,8 +53075,9 @@ patchDefinitions: 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 @@ -60820,9 +53146,11 @@ patchDefinitions: 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 @@ -60843,8 +53171,10 @@ patchDefinitions: 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 @@ -60867,8 +53197,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -60885,10 +53216,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -60964,9 +53297,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -60989,8 +53323,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -61013,7 +53348,9 @@ patchDefinitions: 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: @@ -61096,10 +53433,12 @@ patchDefinitions: 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 @@ -61156,12 +53495,14 @@ patchDefinitions: 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: @@ -61176,7 +53517,9 @@ patchDefinitions: 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: @@ -61211,11 +53554,13 @@ patchDefinitions: 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 @@ -61236,44 +53581,41 @@ patchDefinitions: 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: @@ -61377,8 +53719,10 @@ patchDefinitions: 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 @@ -61391,9 +53735,10 @@ patchDefinitions: 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 @@ -61422,7 +53767,9 @@ patchDefinitions: 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 @@ -61458,10 +53805,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -61482,7 +53830,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -61496,11 +53846,13 @@ patchDefinitions: 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 @@ -61562,22 +53914,20 @@ patchDefinitions: 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 @@ -61634,13 +53984,9 @@ patchDefinitions: 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: @@ -61685,9 +54031,10 @@ patchDefinitions: 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: @@ -61770,26 +54117,28 @@ patchDefinitions: 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 @@ -61825,6 +54174,7 @@ patchDefinitions: 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. @@ -61837,12 +54187,14 @@ patchDefinitions: 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: @@ -61868,12 +54220,14 @@ patchDefinitions: 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: @@ -61899,24 +54253,25 @@ patchDefinitions: 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 @@ -61945,6 +54300,7 @@ patchDefinitions: 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 @@ -61962,17 +54318,19 @@ patchDefinitions: 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 @@ -61995,8 +54353,10 @@ patchDefinitions: 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: @@ -62015,8 +54375,10 @@ patchDefinitions: 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 @@ -62039,7 +54401,8 @@ patchDefinitions: 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: @@ -62058,24 +54421,27 @@ patchDefinitions: 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 @@ -62086,6 +54452,7 @@ patchDefinitions: 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 @@ -62121,11 +54488,13 @@ patchDefinitions: 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 @@ -62138,13 +54507,15 @@ patchDefinitions: 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 @@ -62176,9 +54547,11 @@ patchDefinitions: 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 @@ -62201,14 +54574,16 @@ patchDefinitions: 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 @@ -62234,18 +54609,21 @@ patchDefinitions: 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 @@ -62283,7 +54661,8 @@ patchDefinitions: 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 @@ -62316,10 +54695,11 @@ patchDefinitions: 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 @@ -62339,13 +54719,15 @@ patchDefinitions: 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: @@ -62452,8 +54834,9 @@ patchDefinitions: 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: @@ -62470,7 +54853,8 @@ patchDefinitions: 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: @@ -62492,8 +54876,9 @@ patchDefinitions: 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 @@ -62534,6 +54919,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -62589,9 +54980,10 @@ patchDefinitions: 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 @@ -62626,8 +55018,9 @@ patchDefinitions: 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 @@ -62706,7 +55099,8 @@ patchDefinitions: 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 @@ -62721,17 +55115,19 @@ patchDefinitions: 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 @@ -62778,7 +55174,9 @@ patchDefinitions: 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: @@ -62829,7 +55227,8 @@ patchDefinitions: 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: @@ -62848,17 +55247,18 @@ patchDefinitions: 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) + - 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 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 + - 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 @@ -62898,6 +55298,7 @@ patchDefinitions: 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. @@ -62934,9 +55335,11 @@ patchDefinitions: 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 @@ -62963,7 +55366,8 @@ patchDefinitions: 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: @@ -62990,7 +55394,9 @@ patchDefinitions: 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 @@ -63015,19 +55421,20 @@ patchDefinitions: 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 @@ -63097,6 +55504,7 @@ patchDefinitions: 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. @@ -63119,7 +55527,9 @@ patchDefinitions: 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 @@ -63222,7 +55632,8 @@ patchDefinitions: 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 @@ -63245,7 +55656,9 @@ patchDefinitions: 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 @@ -63267,9 +55680,11 @@ patchDefinitions: 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: @@ -63339,7 +55754,9 @@ patchDefinitions: 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: @@ -63382,9 +55799,11 @@ patchDefinitions: 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 @@ -63423,37 +55842,34 @@ patchDefinitions: 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 @@ -63530,10 +55946,12 @@ patchDefinitions: 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: @@ -63562,9 +55980,11 @@ patchDefinitions: 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: @@ -63590,9 +56010,10 @@ patchDefinitions: 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: @@ -63619,8 +56040,9 @@ patchDefinitions: 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: @@ -63666,8 +56088,10 @@ patchDefinitions: 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: @@ -63686,8 +56110,10 @@ patchDefinitions: 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: @@ -63744,14 +56170,17 @@ patchDefinitions: 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 @@ -63782,6 +56211,7 @@ patchDefinitions: 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 @@ -63810,13 +56240,15 @@ patchDefinitions: 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 @@ -63842,7 +56274,9 @@ patchDefinitions: 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: @@ -63897,14 +56331,15 @@ patchDefinitions: 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 @@ -63970,13 +56405,16 @@ patchDefinitions: 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 @@ -63995,6 +56433,7 @@ patchDefinitions: 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 @@ -64007,7 +56446,9 @@ patchDefinitions: 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: @@ -64030,10 +56471,11 @@ patchDefinitions: 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: @@ -64059,10 +56501,11 @@ patchDefinitions: 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: @@ -64088,9 +56531,10 @@ patchDefinitions: 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 @@ -64113,15 +56557,17 @@ patchDefinitions: 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 @@ -64157,8 +56603,10 @@ patchDefinitions: 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 @@ -64190,15 +56638,17 @@ patchDefinitions: 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 @@ -64226,8 +56676,10 @@ patchDefinitions: 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 @@ -64249,7 +56701,9 @@ patchDefinitions: 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 @@ -64264,11 +56718,12 @@ patchDefinitions: 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 @@ -64315,11 +56770,12 @@ patchDefinitions: 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: @@ -64350,12 +56806,14 @@ patchDefinitions: 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 @@ -64391,19 +56849,20 @@ patchDefinitions: 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 @@ -64428,8 +56887,10 @@ patchDefinitions: 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. @@ -64442,11 +56903,12 @@ patchDefinitions: 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 @@ -64477,12 +56939,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -64511,21 +56967,24 @@ getDefinitions: 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: @@ -64582,15 +57041,18 @@ getDefinitions: 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 @@ -64658,7 +57120,9 @@ getDefinitions: 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: @@ -64718,27 +57182,29 @@ getDefinitions: 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 esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - 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 + -(2) IF this CLOUD-REGION node is deleted, this TO 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 @@ -64770,6 +57236,7 @@ getDefinitions: 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. @@ -64842,20 +57309,22 @@ getDefinitions: 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 @@ -64925,19 +57394,21 @@ getDefinitions: 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 @@ -65017,10 +57488,11 @@ getDefinitions: 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: @@ -65065,10 +57537,12 @@ getDefinitions: 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 @@ -65099,8 +57573,10 @@ getDefinitions: 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: @@ -65125,10 +57601,12 @@ getDefinitions: 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 @@ -65163,8 +57641,9 @@ getDefinitions: 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 @@ -65223,8 +57702,9 @@ getDefinitions: 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 @@ -65300,9 +57780,11 @@ getDefinitions: 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 @@ -65333,8 +57815,10 @@ getDefinitions: 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 @@ -65364,8 +57848,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -65391,10 +57876,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -65476,9 +57963,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -65510,8 +57998,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -65543,7 +58032,9 @@ getDefinitions: 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: @@ -65633,10 +58124,12 @@ getDefinitions: 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 @@ -65700,12 +58193,14 @@ getDefinitions: 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: @@ -65727,7 +58222,9 @@ getDefinitions: 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: @@ -65769,11 +58266,13 @@ getDefinitions: 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 @@ -65808,44 +58307,41 @@ getDefinitions: 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: @@ -65949,8 +58445,10 @@ getDefinitions: 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. @@ -66061,9 +58559,10 @@ getDefinitions: 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 @@ -66099,7 +58598,9 @@ getDefinitions: 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 @@ -66142,10 +58643,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -66177,7 +58679,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -66198,11 +58702,13 @@ getDefinitions: 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 @@ -66275,22 +58781,20 @@ getDefinitions: 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 @@ -66354,13 +58858,9 @@ getDefinitions: 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: @@ -66405,9 +58905,10 @@ getDefinitions: 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: @@ -66501,26 +59002,28 @@ getDefinitions: 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 @@ -66556,16 +59059,19 @@ getDefinitions: 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. @@ -66605,12 +59111,14 @@ getDefinitions: 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: @@ -66649,12 +59157,14 @@ getDefinitions: 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: @@ -66693,24 +59203,25 @@ getDefinitions: 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 @@ -66739,6 +59250,7 @@ getDefinitions: 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 @@ -66784,10 +59296,13 @@ getDefinitions: 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. @@ -66821,17 +59336,19 @@ getDefinitions: 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 @@ -66862,6 +59379,7 @@ getDefinitions: 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: @@ -66882,8 +59400,10 @@ getDefinitions: 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: @@ -66909,8 +59429,10 @@ getDefinitions: 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 @@ -66940,7 +59462,8 @@ getDefinitions: 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: @@ -66966,24 +59489,27 @@ getDefinitions: 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 @@ -66994,6 +59520,7 @@ getDefinitions: 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 @@ -67072,11 +59599,13 @@ getDefinitions: 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 @@ -67092,13 +59621,15 @@ getDefinitions: 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 @@ -67141,9 +59672,11 @@ getDefinitions: 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 @@ -67169,14 +59702,16 @@ getDefinitions: 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 @@ -67219,18 +59754,21 @@ getDefinitions: 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 @@ -67283,7 +59821,8 @@ getDefinitions: 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 @@ -67323,10 +59862,11 @@ getDefinitions: 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 @@ -67356,13 +59896,15 @@ getDefinitions: 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: @@ -67491,8 +60033,9 @@ getDefinitions: 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: @@ -67516,7 +60059,8 @@ getDefinitions: 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: @@ -67545,8 +60089,9 @@ getDefinitions: 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 @@ -67610,6 +60155,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -67665,9 +60216,10 @@ getDefinitions: 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 @@ -67709,8 +60261,9 @@ getDefinitions: 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 @@ -67805,7 +60358,8 @@ getDefinitions: 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 @@ -67827,17 +60381,19 @@ getDefinitions: 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 @@ -67877,6 +60433,7 @@ getDefinitions: 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 @@ -67904,7 +60461,9 @@ getDefinitions: 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: @@ -67962,7 +60521,8 @@ getDefinitions: 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: @@ -67988,17 +60548,18 @@ getDefinitions: 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) + - 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 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 + - 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 @@ -68038,6 +60599,7 @@ getDefinitions: 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. @@ -68095,9 +60657,11 @@ getDefinitions: 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 @@ -68153,7 +60717,8 @@ getDefinitions: 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: @@ -68187,7 +60752,9 @@ getDefinitions: 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 @@ -68214,19 +60781,20 @@ getDefinitions: 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 @@ -68296,6 +60864,7 @@ getDefinitions: 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. @@ -68348,7 +60917,9 @@ getDefinitions: 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 @@ -68463,7 +61034,8 @@ getDefinitions: 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 @@ -68493,7 +61065,9 @@ getDefinitions: 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 @@ -68522,9 +61096,11 @@ getDefinitions: 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: @@ -68605,7 +61181,9 @@ getDefinitions: 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: @@ -68665,9 +61243,11 @@ getDefinitions: 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 @@ -68713,37 +61293,34 @@ getDefinitions: 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 @@ -68841,10 +61418,12 @@ getDefinitions: 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: @@ -68884,9 +61463,11 @@ getDefinitions: 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: @@ -68923,9 +61504,10 @@ getDefinitions: 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: @@ -68963,8 +61545,9 @@ getDefinitions: 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: @@ -69017,8 +61600,10 @@ getDefinitions: 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: @@ -69044,8 +61629,10 @@ getDefinitions: 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: @@ -69112,14 +61699,17 @@ getDefinitions: 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 @@ -69150,6 +61740,7 @@ getDefinitions: 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 @@ -69193,13 +61784,15 @@ getDefinitions: 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 @@ -69236,7 +61829,9 @@ getDefinitions: 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: @@ -69298,14 +61893,15 @@ getDefinitions: 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 @@ -69396,13 +61992,16 @@ getDefinitions: 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 @@ -69421,6 +62020,7 @@ getDefinitions: 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. @@ -69468,7 +62068,9 @@ getDefinitions: 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: @@ -69498,10 +62100,11 @@ getDefinitions: 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: @@ -69540,10 +62143,11 @@ getDefinitions: 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: @@ -69582,9 +62186,10 @@ getDefinitions: 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 @@ -69614,15 +62219,17 @@ getDefinitions: 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 @@ -69662,11 +62269,13 @@ getDefinitions: 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: @@ -69698,8 +62307,10 @@ getDefinitions: 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 @@ -69738,15 +62349,17 @@ getDefinitions: 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 @@ -69774,8 +62387,10 @@ getDefinitions: 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 @@ -69812,7 +62427,9 @@ getDefinitions: 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 @@ -69834,11 +62451,12 @@ getDefinitions: 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 @@ -69892,11 +62510,12 @@ getDefinitions: 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: @@ -69942,12 +62561,14 @@ getDefinitions: 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 @@ -69995,19 +62616,20 @@ getDefinitions: 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 @@ -70032,8 +62654,10 @@ getDefinitions: 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. @@ -70061,11 +62685,12 @@ getDefinitions: 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 diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v8.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v8.yaml index 991c39b8..5c0825e6 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v8.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v8.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string put: tags: - CloudInfrastructure @@ -756,7 +712,7 @@ paths: 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" @@ -829,209 +785,32 @@ paths: 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/v8/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 + - name: volume-group-id in: query - description: Readable name of tenant + 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 @@ -1074,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: - $ref: "#/definitions/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 @@ -1135,25 +903,21 @@ paths: 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: @@ -1187,26 +951,22 @@ paths: 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: @@ -1234,50 +994,35 @@ paths: 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: 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/v8/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 @@ -1312,18 +1057,24 @@ paths: 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/v8/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 @@ -1358,19 +1109,32 @@ paths: 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: @@ -1398,21 +1162,54 @@ paths: 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/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1421,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1456,24 +1253,12 @@ paths: 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 @@ -1520,15 +1305,9 @@ paths: 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/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1537,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1584,27 +1363,19 @@ paths: 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: @@ -1650,86 +1421,130 @@ paths: 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/v8/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: vserver-name - in: query - description: Name of vserver - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + 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: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-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-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: network-name - in: query - description: Name of the network - 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: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __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: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - 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: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure @@ -1868,7 +1683,7 @@ paths: 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" @@ -2117,86 +1932,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - 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 @@ -2335,7 +2070,7 @@ paths: 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" @@ -2456,70 +2191,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -2646,7 +2317,7 @@ paths: 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" @@ -2755,57 +2426,20 @@ paths: 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: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -2972,79 +2606,6 @@ paths: 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: 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 @@ -3171,7 +2732,7 @@ paths: 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" @@ -3280,57 +2841,29 @@ paths: 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: 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: @@ -3595,84 +3128,84 @@ paths: 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: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list + summary: update an existing l3-interface-ipv4-address-list description: | - Create or update an existing l3-interface-ipv4-address-list. + Update an existing l3-interface-ipv4-address-list # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -3721,76 +3254,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv4-address-list - description: | - Update an existing l3-interface-ipv4-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -4015,75 +3479,6 @@ paths: 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: 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 @@ -4210,7 +3605,7 @@ paths: 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" @@ -4319,59 +3714,6 @@ paths: 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: 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 @@ -4486,7 +3828,7 @@ paths: 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" @@ -4583,44 +3925,26 @@ paths: 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 + - name: interface-name in: query - description: Readable name of tenant + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -4663,44 +3987,6 @@ paths: 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: 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 @@ -4803,7 +4089,7 @@ paths: 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" @@ -4888,21 +4174,36 @@ paths: 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: + required: false + type: string + - name: prov-status in: query - description: Readable name of tenant + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -5013,21 +4314,6 @@ paths: 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 put: tags: - CloudInfrastructure @@ -5118,7 +4404,7 @@ paths: 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" @@ -5191,14 +4477,14 @@ paths: 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -5311,21 +4597,6 @@ paths: 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: Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -5416,7 +4687,7 @@ paths: 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" @@ -5489,14 +4760,14 @@ paths: 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: @@ -5609,26 +4880,6 @@ paths: 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 @@ -5719,7 +4970,7 @@ paths: 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" @@ -5792,14 +5043,19 @@ paths: 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: @@ -5912,41 +5168,6 @@ paths: 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 @@ -6037,7 +5258,7 @@ paths: 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" @@ -6110,14 +5331,34 @@ paths: 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: Cloud-owner defined type indicator (e.g., DCP, LCP) + 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: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -6235,36 +5476,6 @@ paths: 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 @@ -6365,7 +5576,7 @@ paths: 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" @@ -6449,34 +5660,9 @@ paths: 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}: @@ -6515,36 +5701,6 @@ paths: 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 @@ -6635,7 +5791,7 @@ paths: 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" @@ -6708,14 +5864,29 @@ paths: 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: Cloud-owner defined type indicator (e.g., DCP, LCP) + 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -6828,21 +5999,6 @@ paths: 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 @@ -6933,7 +6089,7 @@ paths: 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" @@ -7006,14 +6162,14 @@ paths: 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: @@ -7126,27 +6282,6 @@ paths: 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 @@ -7237,7 +6372,7 @@ paths: 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" @@ -7310,16 +6445,22 @@ paths: 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: @@ -7430,16 +6571,6 @@ paths: 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 @@ -7530,7 +6661,7 @@ paths: 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" @@ -7603,14 +6734,9 @@ paths: 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: @@ -7705,16 +6831,6 @@ paths: 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 @@ -7793,7 +6909,7 @@ paths: 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" @@ -7847,6 +6963,27 @@ paths: $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: @@ -7987,7 +7124,7 @@ paths: 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" @@ -8035,6 +7172,12 @@ paths: $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: @@ -8379,62 +7522,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8549,7 +7636,7 @@ paths: 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" @@ -8750,62 +7837,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8920,7 +7951,7 @@ paths: 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" @@ -9017,46 +8048,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -9159,7 +8150,7 @@ paths: 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" @@ -9244,33 +8235,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - 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: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -9401,55 +8379,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -9552,7 +8481,7 @@ paths: 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" @@ -9637,33 +8566,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id + - name: pci-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: vf-vlan-filter in: query - description: alternative pserver name + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -9868,51 +8793,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -10015,7 +8895,7 @@ paths: 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" @@ -10192,51 +9072,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -10339,7 +9174,7 @@ paths: 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" @@ -10424,35 +9259,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -10543,7 +9349,7 @@ paths: 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" @@ -10616,18 +9422,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint + - name: interface-id in: query + description: required: false - type: boolean - - name: pserver-name2 + type: string + - name: macaddr in: query - description: alternative pserver name + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: @@ -10660,20 +9472,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - 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 @@ -10752,7 +9550,7 @@ paths: 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" @@ -10813,18 +9611,9 @@ paths: required: true type: string example: __HOSTNAME__ - - 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: interface-name in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -11121,62 +9910,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11291,7 +10024,7 @@ paths: 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" @@ -11492,62 +10225,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11662,7 +10339,7 @@ paths: 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" @@ -11759,46 +10436,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -11901,7 +10538,7 @@ paths: 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" @@ -11986,33 +10623,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - 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: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -12143,55 +10767,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -12294,7 +10869,7 @@ paths: 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" @@ -12379,33 +10954,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id + - name: pci-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: vf-vlan-filter in: query - description: alternative pserver name + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -12610,51 +11181,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -12757,7 +11283,7 @@ paths: 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" @@ -12934,51 +11460,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -13081,7 +11562,7 @@ paths: 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" @@ -13166,35 +11647,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -13285,7 +11737,7 @@ paths: 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" @@ -13358,18 +11810,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint + - name: interface-id in: query + description: required: false - type: boolean - - name: pserver-name2 + type: string + - name: macaddr in: query - description: alternative pserver name + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: @@ -13402,20 +11860,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - 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 @@ -13494,7 +11938,7 @@ paths: 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" @@ -13555,18 +11999,9 @@ paths: required: true type: string example: __HOSTNAME__ - - 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: interface-name in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}: @@ -13593,20 +12028,6 @@ paths: required: true type: string example: __HOSTNAME__ - - 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 @@ -13673,7 +12094,7 @@ paths: 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" @@ -13721,6 +12142,27 @@ paths: $ref: "#/getDefinitions/pservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: query + description: + required: false + type: string + - name: pserver-id + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: pserver-name2 + in: query + description: + required: false + type: string /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: put: tags: @@ -13795,11 +12237,6 @@ paths: 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 @@ -13866,7 +12303,7 @@ paths: 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" @@ -13914,6 +12351,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -13993,26 +12441,6 @@ paths: required: true type: string example: __METANAME__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -14089,7 +12517,7 @@ paths: 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" @@ -14149,24 +12577,9 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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}: @@ -14193,26 +12606,6 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -14279,7 +12672,7 @@ paths: 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" @@ -14327,6 +12720,32 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: query + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: put: tags: @@ -14442,46 +12861,6 @@ paths: required: true type: string example: __METANAME__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string put: tags: - Business @@ -14582,7 +12961,7 @@ paths: 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" @@ -14666,44 +13045,9 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id + - name: metaname in: query - description: An identifier that customers assign to the location where this service is being used. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: @@ -14742,46 +13086,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string put: tags: - Business @@ -14872,7 +13176,7 @@ paths: 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" @@ -14945,14 +13249,39 @@ paths: 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: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -15047,16 +13376,6 @@ paths: 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 @@ -15135,7 +13454,7 @@ paths: 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" @@ -15196,14 +13515,9 @@ paths: 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: @@ -15280,16 +13594,6 @@ paths: 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 @@ -15356,7 +13660,7 @@ paths: 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" @@ -15404,6 +13708,22 @@ paths: $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: @@ -15478,21 +13798,6 @@ paths: 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 @@ -15559,7 +13864,7 @@ paths: 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" @@ -15607,6 +13912,27 @@ paths: $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: @@ -15681,11 +14007,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -15752,7 +14073,7 @@ paths: 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" @@ -15800,6 +14121,17 @@ paths: $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: @@ -15970,7 +14302,7 @@ paths: 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" @@ -16024,6 +14356,17 @@ paths: $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-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship: put: tags: @@ -16158,26 +14501,6 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -16284,7 +14607,7 @@ paths: 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" @@ -16374,24 +14697,9 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version + - name: element-choice-set-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship: @@ -16513,26 +14821,6 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -16629,7 +14917,7 @@ paths: 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" @@ -16709,24 +14997,9 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version + - name: constrained-element-set-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}: @@ -16763,26 +15036,6 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -16869,7 +15122,7 @@ paths: 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" @@ -16939,24 +15192,9 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version + - name: model-constraint-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: @@ -17048,26 +15286,6 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -17144,7 +15362,7 @@ paths: 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" @@ -17204,24 +15422,9 @@ paths: required: true type: string example: __MODEL-NAME-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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version + - name: model-element-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}: @@ -17253,26 +15456,6 @@ paths: 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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -17349,7 +15532,7 @@ paths: 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" @@ -17409,24 +15592,9 @@ paths: required: true type: string example: __MODEL-NAME-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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version + - name: metaname in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship: @@ -17503,26 +15671,6 @@ paths: required: true type: string example: __MODEL-NAME-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-id - in: query - description: Invariant unique ID which does not change from version to version - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -17589,7 +15737,7 @@ paths: example: __MODEL-NAME-VERSION-ID__ - name: body in: body - description: model object that needs to be created or updated. + description: model object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model" @@ -17637,6 +15785,32 @@ paths: $ref: "#/getDefinitions/models" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-name-version-id + in: query + description: + required: false + type: string + - name: model-type + in: query + description: + required: false + type: string + - name: model-name + in: query + description: + required: false + type: string + - name: model-id + in: query + description: + required: false + type: string + - name: model-version + in: query + description: + required: false + type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship: put: tags: @@ -17738,10 +15912,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -17826,7 +15996,7 @@ paths: 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" @@ -17894,8 +16064,9 @@ paths: 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}: @@ -17931,10 +16102,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18019,7 +16186,7 @@ paths: 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" @@ -18087,8 +16254,9 @@ paths: 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: @@ -18177,10 +16345,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18255,7 +16419,7 @@ paths: 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" @@ -18313,8 +16477,9 @@ paths: 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: @@ -18388,10 +16553,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18456,7 +16617,7 @@ paths: 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" @@ -18503,6 +16664,17 @@ paths: $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: @@ -18577,31 +16749,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: link-id - in: query - description: UUID of the logical-link, SDNC generates this. - required: false - type: string put: tags: - Network @@ -18668,7 +16815,7 @@ paths: 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" @@ -18716,6 +16863,37 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship: put: tags: @@ -18946,7 +17124,7 @@ paths: 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" @@ -19031,6 +17209,11 @@ paths: 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: @@ -19231,7 +17414,7 @@ paths: 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" @@ -19304,6 +17487,11 @@ paths: 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: @@ -19474,7 +17662,7 @@ paths: 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" @@ -19535,6 +17723,11 @@ paths: 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: @@ -19675,7 +17868,7 @@ paths: 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" @@ -19723,6 +17916,12 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: query + description: + required: false + type: string /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: @@ -19797,16 +17996,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: global-route-target - in: query - description: Number used to identify a VPN, globally unique in the network - required: false - type: string put: tags: - Network @@ -19873,7 +18062,7 @@ paths: 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" @@ -19921,6 +18110,22 @@ paths: $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: query + description: + required: false + type: string + - name: vpn-name + in: query + description: + required: false + type: string + - name: global-route-target + in: query + description: + required: false + type: string /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: @@ -20256,53 +18461,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -20415,7 +18573,7 @@ paths: 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" @@ -20612,53 +18770,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -20771,7 +18882,7 @@ paths: 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" @@ -20866,37 +18977,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -20997,7 +19077,7 @@ paths: 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" @@ -21080,24 +19160,20 @@ paths: 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: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -21225,46 +19301,6 @@ paths: 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: 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 @@ -21365,7 +19401,7 @@ paths: 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" @@ -21448,24 +19484,29 @@ paths: 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: interface-id + - name: vf-vlan-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-mac-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-vlan-strip in: query - description: Name of the network + description: + required: false + type: boolean + - name: neutron-network-id + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -21665,42 +19706,6 @@ paths: 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: 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 @@ -21801,7 +19806,7 @@ paths: 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" @@ -21974,42 +19979,6 @@ paths: 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: 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 @@ -22110,7 +20079,7 @@ paths: 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" @@ -22193,26 +20162,6 @@ paths: 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: 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 @@ -22301,7 +20250,7 @@ paths: 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" @@ -22372,9 +20321,24 @@ paths: 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: + required: false + type: string + - name: macaddr + in: query + 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}: @@ -22406,11 +20370,6 @@ paths: 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 put: tags: - Network @@ -22487,7 +20446,7 @@ paths: 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" @@ -22546,9 +20505,9 @@ paths: 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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -22838,53 +20797,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -22997,7 +20909,7 @@ paths: 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" @@ -23194,53 +21106,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -23353,7 +21218,7 @@ paths: 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" @@ -23448,37 +21313,6 @@ paths: 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: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -23579,7 +21413,7 @@ paths: 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" @@ -23662,24 +21496,20 @@ paths: 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: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -23807,46 +21637,6 @@ paths: 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: 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 @@ -23947,7 +21737,7 @@ paths: 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" @@ -24030,24 +21820,29 @@ paths: 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: interface-id + - name: vf-vlan-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-mac-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-vlan-strip + in: query + description: + required: false + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -24247,42 +22042,6 @@ paths: 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: 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 @@ -24383,7 +22142,7 @@ paths: 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" @@ -24556,42 +22315,6 @@ paths: 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: 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 @@ -24692,7 +22415,7 @@ paths: 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" @@ -24775,26 +22498,6 @@ paths: 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: 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 @@ -24883,7 +22586,7 @@ paths: 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" @@ -24954,9 +22657,24 @@ paths: 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: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: @@ -24988,11 +22706,6 @@ paths: 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 put: tags: - Network @@ -25069,7 +22782,7 @@ paths: 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" @@ -25128,9 +22841,9 @@ paths: 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 /network/vpls-pes/vpls-pe/{equipment-name}: @@ -25156,11 +22869,6 @@ paths: 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 @@ -25225,7 +22933,7 @@ paths: 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" @@ -25272,6 +22980,17 @@ paths: $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: @@ -25412,7 +23131,7 @@ paths: 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" @@ -25460,6 +23179,12 @@ paths: $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: @@ -25573,61 +23298,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Expect this to change as ASDC matures. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -25720,7 +23390,7 @@ paths: 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" @@ -25794,61 +23464,12 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Expect this to change as ASDC matures. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id + - 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: @@ -25941,61 +23562,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Expect this to change as ASDC matures. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -26074,7 +23640,7 @@ paths: 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" @@ -26135,44 +23701,24 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id + - name: interface-id in: query - description: Unique identifier of service from ASDC. Expect this to change as ASDC matures. + description: required: false type: string - - name: regional-resource-zone + - name: port-group-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: switch-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/relationship-list/relationship: @@ -26249,46 +23795,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Expect this to change as ASDC matures. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -26355,7 +23861,7 @@ paths: 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" @@ -26403,6 +23909,52 @@ paths: $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: @@ -26477,39 +24029,6 @@ paths: required: true type: string example: __VNFC-NAME__ - - name: vnfc-function-code - in: query - description: function code - required: false - type: string - - name: vnfc-type - in: query - description: type - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string put: tags: - Network @@ -26576,7 +24095,7 @@ paths: 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" @@ -26624,6 +24143,47 @@ paths: $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: query + description: + required: false + type: string + - name: vnfc-function-code + in: query + description: + required: false + type: string + - name: vnfc-type + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: group-notation + in: query + description: + required: false + type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: put: tags: @@ -26716,51 +24276,6 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -26839,7 +24354,7 @@ paths: 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" @@ -26900,44 +24415,14 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - 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: @@ -27035,46 +24520,6 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -27155,7 +24600,7 @@ paths: 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" @@ -27217,46 +24662,12 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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: @@ -27349,46 +24760,6 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -27467,7 +24838,7 @@ paths: 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" @@ -27528,44 +24899,9 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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: @@ -27642,46 +24978,6 @@ paths: 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: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -27748,7 +25044,7 @@ paths: 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" @@ -27796,6 +25092,52 @@ paths: $ref: "#/getDefinitions/l3-networks" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: contrail-network-fqdn + in: query + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: @@ -27870,11 +25212,6 @@ paths: 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 @@ -27941,7 +25278,7 @@ paths: 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" @@ -27989,6 +25326,17 @@ paths: $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: @@ -28241,111 +25589,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -28448,7 +25691,7 @@ paths: 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" @@ -28625,111 +25868,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -28832,7 +25970,7 @@ paths: 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" @@ -28917,95 +26055,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -29096,7 +26145,7 @@ paths: 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" @@ -29169,82 +26218,20 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -29357,104 +26344,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -29545,7 +26434,7 @@ paths: 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" @@ -29618,82 +26507,29 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -29868,100 +26704,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -30052,7 +26794,7 @@ paths: 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" @@ -30205,100 +26947,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -30389,7 +27037,7 @@ paths: 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" @@ -30462,84 +27110,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -30618,7 +27188,7 @@ paths: 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" @@ -30679,67 +27249,24 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id + - name: interface-name in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - - name: persona-model-version + - name: interface-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: macaddr in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: network-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -31036,111 +27563,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -31255,7 +27677,7 @@ paths: 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" @@ -31456,111 +27878,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -31675,7 +27992,7 @@ paths: 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" @@ -31772,95 +28089,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -31963,7 +28191,7 @@ paths: 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" @@ -32048,82 +28276,20 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -32254,104 +28420,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -32454,7 +28522,7 @@ paths: 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" @@ -32539,82 +28607,29 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -32819,100 +28834,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -33015,7 +28936,7 @@ paths: 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" @@ -33192,100 +29113,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -33388,7 +29215,7 @@ paths: 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" @@ -33473,84 +29300,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -33641,7 +29390,7 @@ paths: 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" @@ -33714,67 +29463,24 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id + - name: interface-name in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - - name: persona-model-version + - name: interface-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: macaddr in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: network-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: @@ -33807,69 +29513,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -33948,7 +29591,7 @@ paths: 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" @@ -34009,67 +29652,9 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: interface-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: @@ -34164,104 +29749,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: vf-module-name - in: query - description: Name of vf-module - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - required: false - type: string put: tags: - Network @@ -34340,7 +29827,7 @@ paths: 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" @@ -34401,67 +29888,44 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone + - name: vf-module-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-module-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - name: persona-model-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: persona-model-version in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: + required: false + type: string + - name: contrail-service-instance-fqdn + in: query + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}: @@ -34488,69 +29952,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -34617,7 +30018,7 @@ paths: 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" @@ -34665,6 +30066,77 @@ paths: $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: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: @@ -34805,7 +30277,7 @@ paths: 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" @@ -34853,6 +30325,12 @@ paths: $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: @@ -35105,73 +30583,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -35274,7 +30685,7 @@ paths: 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" @@ -35451,73 +30862,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -35620,7 +30964,7 @@ paths: 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" @@ -35658,104 +31002,53 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-id + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: ID of interface - required: false + description: resource-version for concurrency + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network @@ -35846,7 +31139,7 @@ paths: 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" @@ -35919,44 +31212,20 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -36069,66 +31338,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -36219,7 +31428,7 @@ paths: 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" @@ -36292,44 +31501,29 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC 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: @@ -36504,62 +31698,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -36650,7 +31788,7 @@ paths: 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" @@ -36767,98 +31905,42 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - 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: 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: __VNF-ID2__ + - 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 + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -36949,7 +32031,7 @@ paths: 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" @@ -37022,46 +32104,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -37140,7 +32182,7 @@ paths: 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" @@ -37201,29 +32243,24 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. + description: required: false type: string - - name: prov-status + - name: macaddr in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: network-name in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string /network/newvces/newvce/{vnf-id2}: @@ -37250,31 +32287,6 @@ paths: 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 and clients should expect changes to occur in the future to this field as ASDC matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -37341,7 +32353,7 @@ paths: 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" @@ -37389,6 +32401,37 @@ paths: $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: @@ -37633,153 +32676,106 @@ paths: 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/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - 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: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - 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: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + 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: __L3-INTERFACE-IPV4-ADDRESS__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network @@ -37894,7 +32890,7 @@ paths: 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" @@ -38095,53 +33091,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -38256,7 +33205,7 @@ paths: 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" @@ -38353,37 +33302,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -38486,7 +33404,7 @@ paths: 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" @@ -38571,24 +33489,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -38719,46 +33633,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -38861,7 +33735,7 @@ paths: 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" @@ -38946,24 +33820,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status + - name: pci-id in: query - description: orchestration-status is the status of orchestration on the PNF. + description: required: false type: string - - name: interface-id + - name: vf-vlan-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-mac-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-vlan-strip + in: query + description: + required: false + 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: @@ -39168,42 +34047,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39306,7 +34149,7 @@ paths: 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" @@ -39483,42 +34326,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39621,7 +34428,7 @@ paths: 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" @@ -39706,26 +34513,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -39816,7 +34603,7 @@ paths: 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" @@ -39889,9 +34676,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id in: query - description: orchestration-status is the status of orchestration on the PNF. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -39924,11 +34726,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string put: tags: - Network @@ -40007,7 +34804,7 @@ paths: 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" @@ -40068,9 +34865,9 @@ paths: required: true type: string example: __PNF-NAME__ - - name: orchestration-status + - name: interface-name in: query - description: orchestration-status is the status of orchestration on the PNF. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -40367,53 +35164,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -40528,7 +35278,7 @@ paths: 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" @@ -40729,53 +35479,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -40890,7 +35593,7 @@ paths: 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" @@ -40987,37 +35690,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -41120,7 +35792,7 @@ paths: 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" @@ -41205,24 +35877,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -41353,46 +36021,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -41495,7 +36123,7 @@ paths: 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" @@ -41580,24 +36208,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status + - name: pci-id in: query - description: orchestration-status is the status of orchestration on the PNF. + description: required: false type: string - - name: interface-id + - name: vf-vlan-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-mac-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-vlan-strip + in: query + description: + required: false + 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: @@ -41760,84 +36393,48 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - 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: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network @@ -41940,7 +36537,7 @@ paths: 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" @@ -42117,42 +36714,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -42255,7 +36816,7 @@ paths: 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" @@ -42340,26 +36901,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -42450,7 +36991,7 @@ paths: 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" @@ -42523,9 +37064,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name in: query - description: orchestration-status is the status of orchestration on the PNF. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: @@ -42558,11 +37114,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string put: tags: - Network @@ -42641,7 +37192,7 @@ paths: 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" @@ -42702,9 +37253,9 @@ paths: required: true type: string example: __PNF-NAME__ - - name: orchestration-status + - name: interface-name in: query - description: orchestration-status is the status of orchestration on the PNF. + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -42731,11 +37282,6 @@ paths: required: true type: string example: __PNF-NAME__ - - name: orchestration-status - in: query - description: orchestration-status is the status of orchestration on the PNF. - required: false - type: string put: tags: - Network @@ -42802,7 +37348,7 @@ paths: 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" @@ -42850,6 +37396,17 @@ paths: $ref: "#/getDefinitions/pnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: + required: false + type: string /network/physical-links/physical-link/{link-name}/relationship-list/relationship: put: tags: @@ -42924,11 +37481,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -42995,7 +37547,7 @@ paths: 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" @@ -43043,6 +37595,17 @@ paths: $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: @@ -43263,7 +37826,7 @@ paths: 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" @@ -43324,6 +37887,11 @@ paths: 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: @@ -43414,7 +37982,7 @@ paths: 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" @@ -43462,6 +38030,12 @@ paths: $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: @@ -43536,11 +38110,6 @@ paths: 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 @@ -43607,7 +38176,7 @@ paths: 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" @@ -43655,13 +38224,18 @@ paths: $ref: "#/getDefinitions/route-table-references" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: query + description: + required: false + type: string + - name: route-table-reference-fqdn + in: query + description: + required: false + type: string definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -43690,14 +38264,16 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -43745,15 +38321,18 @@ definitions: 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 @@ -43805,7 +38384,9 @@ definitions: 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: @@ -43861,20 +38442,22 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -43956,18 +38539,20 @@ definitions: 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 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) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE - - 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 oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE + required: - physical-location-id - physical-location-type @@ -44037,13 +38622,15 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -44109,10 +38696,11 @@ definitions: 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: @@ -44157,10 +38745,12 @@ definitions: 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 @@ -44191,7 +38781,9 @@ definitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -44216,9 +38808,11 @@ definitions: 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 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 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 @@ -44253,8 +38847,9 @@ definitions: 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 @@ -44313,8 +38908,9 @@ definitions: 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 @@ -44390,9 +38986,11 @@ definitions: 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 @@ -44423,8 +39021,10 @@ definitions: 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 @@ -44454,8 +39054,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -44481,10 +39082,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -44567,9 +39170,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -44601,8 +39205,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -44634,7 +39239,9 @@ definitions: 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: @@ -44717,9 +39324,11 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -44778,12 +39387,14 @@ definitions: 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: @@ -44805,7 +39416,9 @@ definitions: 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: @@ -44847,11 +39460,13 @@ definitions: 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 @@ -44886,24 +39501,25 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -44988,8 +39604,10 @@ definitions: description: units associated with vdisk, used for VNFs with no vservers/flavors in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -45048,9 +39666,10 @@ definitions: 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 @@ -45086,7 +39705,9 @@ definitions: 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 @@ -45129,10 +39750,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -45164,7 +39786,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -45185,11 +39809,13 @@ definitions: 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 @@ -45262,11 +39888,12 @@ definitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -45319,9 +39946,6 @@ definitions: network: type: object $ref: "#/definitions/network" - aai-internal: - type: object - $ref: "#/definitions/aai-internal" inventory-item: properties: inventory-item-type: @@ -45366,9 +39990,10 @@ definitions: 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: @@ -45462,18 +40087,20 @@ definitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -45536,10 +40163,12 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -45578,10 +40207,12 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -45620,21 +40251,22 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM 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 network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -45663,6 +40295,7 @@ definitions: 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 @@ -45705,10 +40338,13 @@ definitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. subnets: type: array items: @@ -45736,15 +40372,17 @@ definitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -45780,8 +40418,10 @@ definitions: 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: @@ -45807,8 +40447,10 @@ definitions: 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 @@ -45838,7 +40480,8 @@ definitions: 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: @@ -45864,17 +40507,19 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - 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, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, 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, ONE2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, ONE2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -45951,10 +40596,12 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model( metadatum BelongsTo model, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -45971,14 +40618,16 @@ definitions: Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models ###### Related Nodes - TO model( model-element isA model, MANY2ONE) - - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY) - - 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) + - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) - FROM model-element( model-element isA model, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED METADATUM - - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT + - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -(2) IF this MODEL node is deleted, this TO node is DELETED also + -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-name-version-id - model-type @@ -46035,9 +40684,11 @@ definitions: 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 @@ -46060,14 +40711,17 @@ definitions: 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 element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) - TO model( model-element isA model, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model (PARENT of model-element, model startsWith model-element) - - 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 + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model (PARENT of model-element, model startsWith model-element)(3) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -46110,12 +40764,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -46165,7 +40822,8 @@ definitions: 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 @@ -46205,10 +40863,11 @@ definitions: 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 @@ -46238,13 +40897,15 @@ definitions: 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: @@ -46357,7 +41018,8 @@ definitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -46381,7 +41043,8 @@ definitions: 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: @@ -46410,8 +41073,9 @@ definitions: 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 @@ -46475,6 +41139,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -46530,9 +41200,10 @@ definitions: 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 @@ -46574,8 +41245,9 @@ definitions: 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 @@ -46670,7 +41342,8 @@ definitions: 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 @@ -46692,15 +41365,17 @@ definitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -46748,7 +41423,9 @@ definitions: 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: @@ -46792,7 +41469,8 @@ definitions: 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: @@ -46818,11 +41496,12 @@ definitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - 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) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -46862,6 +41541,7 @@ definitions: description: orchestration-status is the status of orchestration on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -46892,9 +41572,11 @@ definitions: 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 @@ -46950,7 +41632,8 @@ definitions: 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: @@ -46984,7 +41667,9 @@ definitions: 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 @@ -47011,18 +41696,19 @@ definitions: 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) - - 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) + - 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 @@ -47074,6 +41760,7 @@ definitions: 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. @@ -47117,7 +41804,9 @@ definitions: 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 @@ -47223,7 +41912,8 @@ definitions: 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 @@ -47253,7 +41943,9 @@ definitions: 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 @@ -47282,9 +41974,11 @@ definitions: 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: @@ -47365,7 +42059,9 @@ definitions: 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: @@ -47425,9 +42121,11 @@ definitions: 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 @@ -47473,19 +42171,21 @@ definitions: 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 connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM - - 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 connector( service-instance Uses connector, MANY2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -47554,10 +42254,12 @@ definitions: 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: @@ -47597,9 +42299,11 @@ definitions: 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: @@ -47636,9 +42340,10 @@ definitions: 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: @@ -47676,8 +42381,9 @@ definitions: 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: @@ -47730,8 +42436,10 @@ definitions: 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: @@ -47757,7 +42465,9 @@ definitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -47824,10 +42534,13 @@ definitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -47858,6 +42571,7 @@ definitions: 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 @@ -47887,13 +42601,15 @@ definitions: 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 @@ -47927,7 +42643,9 @@ definitions: 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 - bandwidth-up-wan1 @@ -47993,12 +42711,13 @@ definitions: 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 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 PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -48081,12 +42800,15 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -48105,6 +42827,7 @@ definitions: 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. @@ -48142,7 +42865,9 @@ definitions: 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: @@ -48172,10 +42897,11 @@ definitions: 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: @@ -48214,10 +42940,11 @@ definitions: 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: @@ -48256,9 +42983,10 @@ definitions: 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 @@ -48288,14 +43016,16 @@ definitions: 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 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 service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface properties: @@ -48359,8 +43089,10 @@ definitions: 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 @@ -48399,9 +43131,11 @@ definitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -48429,8 +43163,10 @@ definitions: 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 @@ -48453,7 +43189,9 @@ definitions: 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 @@ -48475,11 +43213,12 @@ definitions: 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 @@ -48527,11 +43266,12 @@ definitions: 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: @@ -48577,8 +43317,10 @@ definitions: description: | VPN binding ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK + required: - vpn-id - vpn-name @@ -48614,19 +43356,20 @@ definitions: 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 @@ -48651,8 +43394,10 @@ definitions: 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. @@ -48680,10 +43425,11 @@ definitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -48721,12 +43467,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -48755,14 +43495,16 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -48799,15 +43541,18 @@ patchDefinitions: 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 @@ -48852,7 +43597,9 @@ patchDefinitions: 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: @@ -48901,20 +43648,22 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -48953,18 +43702,20 @@ patchDefinitions: 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 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) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE - - 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 oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE + required: - physical-location-id - physical-location-type @@ -48998,13 +43749,15 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -49059,10 +43812,11 @@ patchDefinitions: 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: @@ -49081,10 +43835,12 @@ patchDefinitions: 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 @@ -49105,7 +43861,9 @@ patchDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -49123,9 +43881,11 @@ patchDefinitions: 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 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 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 @@ -49153,8 +43913,9 @@ patchDefinitions: 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 @@ -49195,8 +43956,9 @@ patchDefinitions: 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 @@ -49265,9 +44027,11 @@ patchDefinitions: 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 @@ -49288,8 +44052,10 @@ patchDefinitions: 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 @@ -49312,8 +44078,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -49330,10 +44097,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -49409,9 +44178,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -49434,8 +44204,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -49458,7 +44229,9 @@ patchDefinitions: 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: @@ -49534,9 +44307,11 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -49588,12 +44363,14 @@ patchDefinitions: 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: @@ -49608,7 +44385,9 @@ patchDefinitions: 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: @@ -49643,11 +44422,13 @@ patchDefinitions: 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 @@ -49668,24 +44449,25 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -49770,8 +44552,10 @@ patchDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node generic-vnfs: description: | Collection of VNFs @@ -49784,9 +44568,10 @@ patchDefinitions: 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 @@ -49815,7 +44600,9 @@ patchDefinitions: 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 @@ -49851,10 +44638,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -49875,7 +44663,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -49889,11 +44679,13 @@ patchDefinitions: 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 @@ -49955,11 +44747,12 @@ patchDefinitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -50005,9 +44798,6 @@ patchDefinitions: network: type: object $ref: "#/patchDefinitions/network" - aai-internal: - type: object - $ref: "#/patchDefinitions/aai-internal" inventory-item: properties: inventory-item-type: @@ -50052,9 +44842,10 @@ patchDefinitions: 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: @@ -50137,18 +44928,20 @@ patchDefinitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -50188,10 +44981,12 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -50217,10 +45012,12 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -50246,21 +45043,22 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM 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 network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -50289,6 +45087,7 @@ patchDefinitions: 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 @@ -50306,15 +45105,17 @@ patchDefinitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -50333,8 +45134,10 @@ patchDefinitions: 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: @@ -50353,8 +45156,10 @@ patchDefinitions: 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 @@ -50377,7 +45182,8 @@ patchDefinitions: 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: @@ -50396,17 +45202,19 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - 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, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, 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, ONE2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, ONE2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -50449,10 +45257,12 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model( metadatum BelongsTo model, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -50466,14 +45276,16 @@ patchDefinitions: Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models ###### Related Nodes - TO model( model-element isA model, MANY2ONE) - - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY) - - 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) + - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) - FROM model-element( model-element isA model, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED METADATUM - - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT + - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -(2) IF this MODEL node is deleted, this TO node is DELETED also + -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-name-version-id - model-type @@ -50515,9 +45327,11 @@ patchDefinitions: 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 @@ -50540,14 +45354,17 @@ patchDefinitions: 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 element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) - TO model( model-element isA model, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model (PARENT of model-element, model startsWith model-element) - - 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 + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model (PARENT of model-element, model startsWith model-element)(3) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -50573,12 +45390,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -50613,7 +45433,8 @@ patchDefinitions: 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 @@ -50646,10 +45467,11 @@ patchDefinitions: 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 @@ -50669,13 +45491,15 @@ patchDefinitions: 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: @@ -50766,7 +45590,8 @@ patchDefinitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -50783,7 +45608,8 @@ patchDefinitions: 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: @@ -50805,8 +45631,9 @@ patchDefinitions: 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 @@ -50847,6 +45674,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -50902,9 +45735,10 @@ patchDefinitions: 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 @@ -50939,8 +45773,9 @@ patchDefinitions: 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 @@ -51019,7 +45854,8 @@ patchDefinitions: 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 @@ -51034,15 +45870,17 @@ patchDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -51079,7 +45917,9 @@ patchDefinitions: 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: @@ -51116,7 +45956,8 @@ patchDefinitions: 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: @@ -51135,11 +45976,12 @@ patchDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - 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) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -51179,6 +46021,7 @@ patchDefinitions: description: orchestration-status is the status of orchestration on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -51194,9 +46037,11 @@ patchDefinitions: 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 @@ -51223,7 +46068,8 @@ patchDefinitions: 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: @@ -51250,7 +46096,9 @@ patchDefinitions: 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 @@ -51275,18 +46123,19 @@ patchDefinitions: 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) - - 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) + - 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 @@ -51338,6 +46187,7 @@ patchDefinitions: 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. @@ -51360,7 +46210,9 @@ patchDefinitions: 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 @@ -51458,7 +46310,8 @@ patchDefinitions: 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 @@ -51481,7 +46334,9 @@ patchDefinitions: 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 @@ -51503,9 +46358,11 @@ patchDefinitions: 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: @@ -51575,7 +46432,9 @@ patchDefinitions: 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: @@ -51618,9 +46477,11 @@ patchDefinitions: 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 @@ -51659,19 +46520,21 @@ patchDefinitions: 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 connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM - - 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 connector( service-instance Uses connector, MANY2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -51729,10 +46592,12 @@ patchDefinitions: 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: @@ -51761,9 +46626,11 @@ patchDefinitions: 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: @@ -51789,9 +46656,10 @@ patchDefinitions: 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: @@ -51818,8 +46686,9 @@ patchDefinitions: 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: @@ -51865,8 +46734,10 @@ patchDefinitions: 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: @@ -51885,7 +46756,9 @@ patchDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -51942,10 +46815,13 @@ patchDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -51976,6 +46852,7 @@ patchDefinitions: 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 @@ -51998,13 +46875,15 @@ patchDefinitions: 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 @@ -52027,7 +46906,9 @@ patchDefinitions: 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 - bandwidth-up-wan1 @@ -52086,12 +46967,13 @@ patchDefinitions: 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 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 PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -52157,12 +47039,15 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -52181,6 +47066,7 @@ patchDefinitions: 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 @@ -52193,7 +47079,9 @@ patchDefinitions: 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: @@ -52216,10 +47104,11 @@ patchDefinitions: 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: @@ -52245,10 +47134,11 @@ patchDefinitions: 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: @@ -52274,9 +47164,10 @@ patchDefinitions: 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 @@ -52299,14 +47190,16 @@ patchDefinitions: 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 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 service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface properties: @@ -52340,8 +47233,10 @@ patchDefinitions: 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 @@ -52373,9 +47268,11 @@ patchDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -52403,8 +47300,10 @@ patchDefinitions: 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 @@ -52420,7 +47319,9 @@ patchDefinitions: 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 @@ -52435,11 +47336,12 @@ patchDefinitions: 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 @@ -52480,11 +47382,12 @@ patchDefinitions: 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: @@ -52515,8 +47418,10 @@ patchDefinitions: description: | VPN binding ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK + required: - vpn-id - vpn-name @@ -52544,19 +47449,20 @@ patchDefinitions: 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 @@ -52581,8 +47487,10 @@ patchDefinitions: 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. @@ -52595,10 +47503,11 @@ patchDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -52629,12 +47538,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -52663,14 +47566,16 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -52718,15 +47623,18 @@ getDefinitions: 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 @@ -52778,7 +47686,9 @@ getDefinitions: 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: @@ -52834,20 +47744,22 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -52929,18 +47841,20 @@ getDefinitions: 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 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) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE - - 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 oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE + required: - physical-location-id - physical-location-type @@ -53010,13 +47924,15 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -53082,10 +47998,11 @@ getDefinitions: 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: @@ -53130,10 +48047,12 @@ getDefinitions: 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 @@ -53164,7 +48083,9 @@ getDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -53189,9 +48110,11 @@ getDefinitions: 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 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 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 @@ -53226,8 +48149,9 @@ getDefinitions: 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 @@ -53286,8 +48210,9 @@ getDefinitions: 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 @@ -53363,9 +48288,11 @@ getDefinitions: 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 @@ -53396,8 +48323,10 @@ getDefinitions: 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 @@ -53427,8 +48356,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -53454,10 +48384,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -53540,9 +48472,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -53574,8 +48507,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -53607,7 +48541,9 @@ getDefinitions: 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: @@ -53690,9 +48626,11 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -53751,12 +48689,14 @@ getDefinitions: 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: @@ -53778,7 +48718,9 @@ getDefinitions: 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: @@ -53820,11 +48762,13 @@ getDefinitions: 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 @@ -53859,24 +48803,25 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -53961,8 +48906,10 @@ getDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -54021,9 +48968,10 @@ getDefinitions: 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 @@ -54059,7 +49007,9 @@ getDefinitions: 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 @@ -54102,10 +49052,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -54137,7 +49088,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -54158,11 +49111,13 @@ getDefinitions: 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 @@ -54235,11 +49190,12 @@ getDefinitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -54292,9 +49248,6 @@ getDefinitions: network: type: object $ref: "#/getDefinitions/network" - aai-internal: - type: object - $ref: "#/getDefinitions/aai-internal" inventory-item: properties: inventory-item-type: @@ -54339,9 +49292,10 @@ getDefinitions: 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: @@ -54435,18 +49389,20 @@ getDefinitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -54509,10 +49465,12 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -54551,10 +49509,12 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -54593,21 +49553,22 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM 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 network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -54636,6 +49597,7 @@ getDefinitions: 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 @@ -54678,10 +49640,13 @@ getDefinitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. subnets: type: array items: @@ -54709,15 +49674,17 @@ getDefinitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -54753,8 +49720,10 @@ getDefinitions: 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: @@ -54780,8 +49749,10 @@ getDefinitions: 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 @@ -54811,7 +49782,8 @@ getDefinitions: 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: @@ -54837,17 +49809,19 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - 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, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, 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, ONE2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, ONE2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -54924,10 +49898,12 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model( metadatum BelongsTo model, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -54944,14 +49920,16 @@ getDefinitions: Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models ###### Related Nodes - TO model( model-element isA model, MANY2ONE) - - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY) - - 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) + - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) - FROM model-element( model-element isA model, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED METADATUM - - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT + - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -(2) IF this MODEL node is deleted, this TO node is DELETED also + -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-name-version-id - model-type @@ -55008,9 +49986,11 @@ getDefinitions: 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 @@ -55033,14 +50013,17 @@ getDefinitions: 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 element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) - TO model( model-element isA model, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model (PARENT of model-element, model startsWith model-element) - - 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 + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model (PARENT of model-element, model startsWith model-element)(3) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -55083,12 +50066,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -55138,7 +50124,8 @@ getDefinitions: 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 @@ -55178,10 +50165,11 @@ getDefinitions: 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 @@ -55211,13 +50199,15 @@ getDefinitions: 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: @@ -55330,7 +50320,8 @@ getDefinitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -55354,7 +50345,8 @@ getDefinitions: 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: @@ -55383,8 +50375,9 @@ getDefinitions: 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 @@ -55448,6 +50441,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -55503,9 +50502,10 @@ getDefinitions: 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 @@ -55547,8 +50547,9 @@ getDefinitions: 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 @@ -55643,7 +50644,8 @@ getDefinitions: 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 @@ -55665,15 +50667,17 @@ getDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -55721,7 +50725,9 @@ getDefinitions: 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: @@ -55765,7 +50771,8 @@ getDefinitions: 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: @@ -55791,11 +50798,12 @@ getDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - 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) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -55835,6 +50843,7 @@ getDefinitions: description: orchestration-status is the status of orchestration on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -55865,9 +50874,11 @@ getDefinitions: 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 @@ -55923,7 +50934,8 @@ getDefinitions: 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: @@ -55957,7 +50969,9 @@ getDefinitions: 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 @@ -55984,18 +50998,19 @@ getDefinitions: 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) - - 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) + - 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 @@ -56047,6 +51062,7 @@ getDefinitions: 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. @@ -56090,7 +51106,9 @@ getDefinitions: 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 @@ -56200,7 +51218,8 @@ getDefinitions: 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 @@ -56230,7 +51249,9 @@ getDefinitions: 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 @@ -56259,9 +51280,11 @@ getDefinitions: 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: @@ -56342,7 +51365,9 @@ getDefinitions: 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: @@ -56402,9 +51427,11 @@ getDefinitions: 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 @@ -56450,19 +51477,21 @@ getDefinitions: 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 connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM - - 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 connector( service-instance Uses connector, MANY2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -56531,10 +51560,12 @@ getDefinitions: 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: @@ -56574,9 +51605,11 @@ getDefinitions: 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: @@ -56613,9 +51646,10 @@ getDefinitions: 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: @@ -56653,8 +51687,9 @@ getDefinitions: 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: @@ -56707,8 +51742,10 @@ getDefinitions: 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: @@ -56734,7 +51771,9 @@ getDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -56801,10 +51840,13 @@ getDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -56835,6 +51877,7 @@ getDefinitions: 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 @@ -56864,13 +51907,15 @@ getDefinitions: 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 @@ -56904,7 +51949,9 @@ getDefinitions: 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 - bandwidth-up-wan1 @@ -56970,12 +52017,13 @@ getDefinitions: 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 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 PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -57058,12 +52106,15 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -57082,6 +52133,7 @@ getDefinitions: 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. @@ -57119,7 +52171,9 @@ getDefinitions: 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: @@ -57149,10 +52203,11 @@ getDefinitions: 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: @@ -57191,10 +52246,11 @@ getDefinitions: 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: @@ -57233,9 +52289,10 @@ getDefinitions: 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 @@ -57265,14 +52322,16 @@ getDefinitions: 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 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 service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface properties: @@ -57336,8 +52395,10 @@ getDefinitions: 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 @@ -57376,9 +52437,11 @@ getDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -57406,8 +52469,10 @@ getDefinitions: 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 @@ -57430,7 +52495,9 @@ getDefinitions: 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 @@ -57452,11 +52519,12 @@ getDefinitions: 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 @@ -57504,11 +52572,12 @@ getDefinitions: 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: @@ -57554,8 +52623,10 @@ getDefinitions: description: | VPN binding ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK + required: - vpn-id - vpn-name @@ -57591,19 +52662,20 @@ getDefinitions: 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 @@ -57628,8 +52700,10 @@ getDefinitions: 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. @@ -57657,10 +52731,11 @@ getDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml index 1fc4e0da..66724c00 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml @@ -141,21 +141,6 @@ paths: 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 @@ -246,7 +231,7 @@ paths: 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" @@ -313,19 +298,9 @@ paths: 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: @@ -402,21 +377,6 @@ paths: 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 @@ -483,7 +443,7 @@ paths: 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" @@ -531,6 +491,27 @@ paths: $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: @@ -641,31 +622,6 @@ paths: 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 @@ -756,7 +712,7 @@ paths: 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" @@ -829,209 +785,32 @@ paths: 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/v9/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 + - name: volume-group-id in: query - description: Readable name of tenant + 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 @@ -1074,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 @@ -1135,25 +903,21 @@ paths: 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: @@ -1187,26 +951,22 @@ paths: 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: @@ -1234,50 +994,35 @@ paths: 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: 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/v9/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 @@ -1312,18 +1057,24 @@ paths: 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/v9/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 @@ -1358,19 +1109,32 @@ paths: 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: @@ -1398,21 +1162,54 @@ paths: 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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1421,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1456,24 +1253,12 @@ paths: 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 @@ -1520,15 +1305,9 @@ paths: 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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1537,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1584,27 +1363,19 @@ paths: 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: @@ -1650,86 +1421,130 @@ paths: 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/v9/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: vserver-name - in: query - description: Name of vserver - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + 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: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-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-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: network-name - in: query - description: Name of the network - 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: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __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: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - 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: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure @@ -1868,7 +1683,7 @@ paths: 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" @@ -2117,86 +1932,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - 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 @@ -2335,7 +2070,7 @@ paths: 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" @@ -2456,70 +2191,6 @@ paths: 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: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -2646,7 +2317,7 @@ paths: 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" @@ -2755,57 +2426,20 @@ paths: 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: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -2972,79 +2606,6 @@ paths: 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: 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 @@ -3171,7 +2732,7 @@ paths: 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" @@ -3280,57 +2841,29 @@ paths: 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: 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: @@ -3595,84 +3128,84 @@ paths: 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: 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 + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list + summary: update an existing l3-interface-ipv4-address-list description: | - Create or update an existing l3-interface-ipv4-address-list. + Update an existing l3-interface-ipv4-address-list # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -3721,76 +3254,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv4-address-list - description: | - Update an existing l3-interface-ipv4-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -4015,75 +3479,6 @@ paths: 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: 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 @@ -4210,7 +3605,7 @@ paths: 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" @@ -4319,59 +3714,6 @@ paths: 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: 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 @@ -4486,7 +3828,7 @@ paths: 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" @@ -4583,44 +3925,26 @@ paths: 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 + - name: interface-name in: query - description: Readable name of tenant + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -4663,44 +3987,6 @@ paths: 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: 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 @@ -4803,7 +4089,7 @@ paths: 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" @@ -4888,21 +4174,36 @@ paths: 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: + required: false + type: string + - name: prov-status in: query - description: Readable name of tenant + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -5013,21 +4314,6 @@ paths: 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 put: tags: - CloudInfrastructure @@ -5118,7 +4404,7 @@ paths: 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" @@ -5191,14 +4477,14 @@ paths: 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -5311,21 +4597,6 @@ paths: 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: Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -5416,7 +4687,7 @@ paths: 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" @@ -5489,14 +4760,14 @@ paths: 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: @@ -5609,26 +4880,6 @@ paths: 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 @@ -5719,7 +4970,7 @@ paths: 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" @@ -5792,14 +5043,19 @@ paths: 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: @@ -5912,41 +5168,6 @@ paths: 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 @@ -6037,7 +5258,7 @@ paths: 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" @@ -6110,14 +5331,34 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -6235,36 +5476,6 @@ paths: 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 @@ -6365,7 +5576,7 @@ paths: 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" @@ -6449,34 +5660,9 @@ paths: 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}: @@ -6515,36 +5701,6 @@ paths: 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 @@ -6635,7 +5791,7 @@ paths: 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" @@ -6708,14 +5864,29 @@ paths: 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: Cloud-owner defined type indicator (e.g., dcp, lcp) + 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -6828,21 +5999,6 @@ paths: 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 @@ -6933,7 +6089,7 @@ paths: 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" @@ -7006,14 +6162,14 @@ paths: 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: @@ -7126,27 +6282,6 @@ paths: 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 @@ -7237,7 +6372,7 @@ paths: 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" @@ -7310,16 +6445,22 @@ paths: 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: @@ -7430,16 +6571,6 @@ paths: 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 @@ -7530,7 +6661,7 @@ paths: 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" @@ -7603,14 +6734,9 @@ paths: 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: @@ -7705,16 +6831,6 @@ paths: 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 @@ -7793,7 +6909,7 @@ paths: 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" @@ -7847,6 +6963,27 @@ paths: $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: @@ -7987,7 +7124,7 @@ paths: 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" @@ -8035,6 +7172,12 @@ paths: $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: @@ -8379,72 +7522,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8559,7 +7636,7 @@ paths: 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" @@ -8760,72 +7837,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8940,7 +7951,7 @@ paths: 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" @@ -9037,56 +8048,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -9189,7 +8150,7 @@ paths: 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" @@ -9274,43 +8235,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -9441,65 +8379,6 @@ paths: 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: 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: - CloudInfrastructure @@ -9602,7 +8481,7 @@ paths: 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" @@ -9687,43 +8566,29 @@ paths: 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: @@ -9928,61 +8793,6 @@ paths: 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 @@ -10085,7 +8895,7 @@ paths: 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" @@ -10262,61 +9072,6 @@ paths: 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 @@ -10419,7 +9174,7 @@ paths: 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" @@ -10504,45 +9259,6 @@ paths: 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 @@ -10633,7 +9349,7 @@ paths: 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" @@ -10706,28 +9422,24 @@ paths: 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}: @@ -10760,30 +9472,6 @@ paths: 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 @@ -10862,7 +9550,7 @@ paths: 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" @@ -10923,23 +9611,14 @@ paths: 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: @@ -11236,77 +9915,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11421,7 +10029,7 @@ paths: 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" @@ -11622,77 +10230,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11807,7 +10344,7 @@ paths: 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" @@ -11904,61 +10441,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -12061,7 +10543,7 @@ paths: 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" @@ -12146,48 +10628,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -12318,70 +10772,6 @@ paths: 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 @@ -12484,7 +10874,7 @@ paths: 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" @@ -12569,48 +10959,29 @@ paths: 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: @@ -12815,66 +11186,6 @@ paths: 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 @@ -12977,7 +11288,7 @@ paths: 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" @@ -13154,66 +11465,6 @@ paths: 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 @@ -13316,7 +11567,7 @@ paths: 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" @@ -13401,50 +11652,6 @@ paths: 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 @@ -13535,7 +11742,7 @@ paths: 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" @@ -13608,33 +11815,24 @@ paths: 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}: @@ -13667,35 +11865,6 @@ paths: 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 @@ -13774,7 +11943,7 @@ paths: 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" @@ -13835,23 +12004,19 @@ paths: 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}: @@ -13878,25 +12043,6 @@ paths: 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 @@ -13963,7 +12109,7 @@ paths: 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" @@ -14011,6 +12157,32 @@ paths: $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: @@ -14085,11 +12257,6 @@ paths: 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 @@ -14156,7 +12323,7 @@ paths: 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" @@ -14204,6 +12371,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -14283,26 +12461,6 @@ paths: required: true type: string example: __METANAME__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -14379,7 +12537,7 @@ paths: 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" @@ -14439,24 +12597,9 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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}: @@ -14483,26 +12626,6 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -14569,7 +12692,7 @@ paths: 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" @@ -14617,6 +12740,32 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: query + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: put: tags: @@ -14732,51 +12881,6 @@ paths: required: true type: string example: __METANAME__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string put: tags: - Business @@ -14877,7 +12981,7 @@ paths: 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" @@ -14961,49 +13065,9 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status + - name: metaname 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: @@ -15152,61 +13216,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Business @@ -15321,7 +13330,7 @@ paths: 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" @@ -15418,59 +13427,9 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version + - name: id in: query - description: the ASDC model version for this resource or service model. + 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: @@ -15601,61 +13560,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Business @@ -15758,7 +13662,7 @@ paths: 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" @@ -15843,49 +13747,19 @@ paths: 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 + - name: id in: query - description: This field will store a name assigned to the service-instance. + description: required: false type: string - name: persona-model-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: persona-model-version in: query - description: the ASDC model version for this resource or service model. - 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}: @@ -15924,51 +13798,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string put: tags: - Business @@ -16059,7 +13888,7 @@ paths: 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" @@ -16132,14 +13961,44 @@ paths: 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: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + 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: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -16234,16 +14093,6 @@ paths: 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 @@ -16322,7 +14171,7 @@ paths: 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" @@ -16383,14 +14232,9 @@ paths: 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: @@ -16467,16 +14311,6 @@ paths: 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 @@ -16543,7 +14377,7 @@ paths: 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" @@ -16591,6 +14425,22 @@ paths: $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: @@ -16665,21 +14515,6 @@ paths: 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 @@ -16746,7 +14581,7 @@ paths: 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" @@ -16794,6 +14629,27 @@ paths: $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: @@ -16868,11 +14724,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -16939,7 +14790,7 @@ paths: 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" @@ -16987,6 +14838,17 @@ paths: $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: @@ -17157,7 +15019,7 @@ paths: 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" @@ -17211,6 +15073,17 @@ paths: $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: @@ -17363,21 +15236,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -17496,7 +15354,7 @@ paths: 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" @@ -17598,19 +15456,9 @@ paths: 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 + - name: element-choice-set-uuid in: query - description: Version + 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: @@ -17750,21 +15598,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -17873,7 +15706,7 @@ paths: 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" @@ -17965,19 +15798,9 @@ paths: 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 + - name: constrained-element-set-uuid in: query - description: Version + 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}: @@ -18020,21 +15843,6 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18133,7 +15941,7 @@ paths: 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" @@ -18215,19 +16023,9 @@ paths: 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 + - name: model-constraint-uuid in: query - description: Version + 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: @@ -18337,21 +16135,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18440,7 +16223,7 @@ paths: 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" @@ -18512,19 +16295,9 @@ paths: 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 + - name: model-element-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: @@ -18562,21 +16335,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18665,7 +16423,7 @@ paths: 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" @@ -18737,19 +16495,9 @@ paths: 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 + - name: metaname in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: @@ -18844,21 +16592,6 @@ paths: 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 put: tags: - ServiceDesignAndCreation @@ -18937,7 +16670,7 @@ paths: 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" @@ -18998,9 +16731,19 @@ paths: 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: Type of the model, e.g., service, resource, widget, etc. + description: + required: false + type: string + - name: model-version + in: query + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -19077,11 +16820,6 @@ paths: 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 @@ -19148,7 +16886,7 @@ paths: 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" @@ -19196,6 +16934,17 @@ paths: $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: @@ -19297,10 +17046,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19385,7 +17130,7 @@ paths: 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" @@ -19453,8 +17198,9 @@ paths: 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}: @@ -19490,10 +17236,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19578,7 +17320,7 @@ paths: 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" @@ -19646,8 +17388,9 @@ paths: 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: @@ -19736,10 +17479,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19814,7 +17553,7 @@ paths: 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" @@ -19872,8 +17611,9 @@ paths: 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: @@ -19947,10 +17687,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20015,7 +17751,7 @@ paths: 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" @@ -20062,6 +17798,17 @@ paths: $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: @@ -20136,46 +17883,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: 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 @@ -20242,7 +17949,7 @@ paths: 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" @@ -20290,6 +17997,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - 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: @@ -20520,7 +18273,7 @@ paths: 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" @@ -20605,6 +18358,11 @@ paths: 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: @@ -20805,7 +18563,7 @@ paths: 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" @@ -20878,6 +18636,11 @@ paths: 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: @@ -21048,7 +18811,7 @@ paths: 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" @@ -21109,6 +18872,11 @@ paths: 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: @@ -21249,7 +19017,7 @@ paths: 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" @@ -21297,6 +19065,12 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: query + description: + required: false + type: string /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: @@ -21371,21 +19145,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: global-route-target - in: query - description: Number used to identify a VPN, globally unique in the network - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string put: tags: - Network @@ -21452,7 +19211,7 @@ paths: 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" @@ -21500,6 +19259,27 @@ paths: $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: query + description: + required: false + type: string + - name: vpn-name + in: query + description: + required: false + type: string + - name: global-route-target + in: query + description: + required: false + type: string + - name: vpn-type + in: query + description: + required: false + type: string /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: @@ -21835,58 +19615,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -21999,7 +19727,7 @@ paths: 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" @@ -22196,58 +19924,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -22360,7 +20036,7 @@ paths: 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" @@ -22455,42 +20131,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -22591,7 +20231,7 @@ paths: 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" @@ -22674,29 +20314,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -22824,51 +20455,6 @@ paths: 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 @@ -22969,7 +20555,7 @@ paths: 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" @@ -23052,29 +20638,29 @@ paths: 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: @@ -23274,47 +20860,6 @@ paths: 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 @@ -23415,7 +20960,7 @@ paths: 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" @@ -23588,47 +21133,6 @@ paths: 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 @@ -23729,7 +21233,7 @@ paths: 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" @@ -23812,31 +21316,6 @@ paths: 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 @@ -23925,7 +21404,7 @@ paths: 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" @@ -23996,14 +21475,24 @@ paths: 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: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: @@ -24035,16 +21524,6 @@ paths: 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 @@ -24121,7 +21600,7 @@ paths: 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" @@ -24180,9 +21659,14 @@ paths: 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: @@ -24472,63 +21956,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -24641,7 +22068,7 @@ paths: 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" @@ -24838,63 +22265,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -25007,7 +22377,7 @@ paths: 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" @@ -25102,47 +22472,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -25243,7 +22572,7 @@ paths: 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" @@ -25326,34 +22655,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -25481,56 +22796,6 @@ paths: 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 @@ -25631,7 +22896,7 @@ paths: 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" @@ -25714,34 +22979,29 @@ paths: 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: @@ -25941,52 +23201,6 @@ paths: 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 @@ -26087,7 +23301,7 @@ paths: 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" @@ -26260,52 +23474,6 @@ paths: 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: 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 @@ -26406,7 +23574,7 @@ paths: 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" @@ -26489,36 +23657,6 @@ paths: 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 @@ -26607,7 +23745,7 @@ paths: 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" @@ -26678,19 +23816,24 @@ paths: 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}: @@ -26722,21 +23865,6 @@ paths: 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 @@ -26813,7 +23941,7 @@ paths: 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" @@ -26872,9 +24000,19 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}: @@ -26900,11 +24038,6 @@ paths: 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 @@ -26969,7 +24102,7 @@ paths: 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" @@ -27016,6 +24149,17 @@ paths: $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: @@ -27156,7 +24300,7 @@ paths: 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" @@ -27204,6 +24348,12 @@ paths: $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: @@ -27317,61 +24467,6 @@ paths: 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 @@ -27464,7 +24559,7 @@ paths: 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" @@ -27538,61 +24633,12 @@ paths: 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: @@ -27685,61 +24731,6 @@ paths: 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 @@ -27818,7 +24809,7 @@ paths: 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" @@ -27879,44 +24870,24 @@ paths: 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: @@ -28029,46 +25000,6 @@ paths: 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 @@ -28159,7 +25090,7 @@ paths: 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" @@ -28226,44 +25157,14 @@ paths: 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: @@ -28376,46 +25277,6 @@ paths: 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 @@ -28506,7 +25367,7 @@ paths: 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" @@ -28573,44 +25434,14 @@ paths: 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: @@ -28687,46 +25518,6 @@ paths: 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 @@ -28793,7 +25584,7 @@ paths: 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" @@ -28841,6 +25632,52 @@ paths: $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: @@ -28915,39 +25752,6 @@ paths: required: true type: string example: __VNFC-NAME__ - - name: vnfc-function-code - in: query - description: function code - required: false - type: string - - name: vnfc-type - in: query - description: type - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string put: tags: - Network @@ -29014,7 +25818,7 @@ paths: 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" @@ -29062,6 +25866,47 @@ paths: $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: query + description: + required: false + type: string + - name: vnfc-function-code + in: query + description: + required: false + type: string + - name: vnfc-type + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: group-notation + in: query + description: + required: false + type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: put: tags: @@ -29154,56 +25999,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -29282,7 +26077,7 @@ paths: 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" @@ -29343,49 +26138,14 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - 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: @@ -29483,51 +26243,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -29608,7 +26323,7 @@ paths: 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" @@ -29670,51 +26385,12 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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: @@ -29807,51 +26483,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -29930,7 +26561,7 @@ paths: 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" @@ -29991,49 +26622,9 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - 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: @@ -30110,51 +26701,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -30221,7 +26767,7 @@ paths: 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" @@ -30269,6 +26815,57 @@ paths: $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: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: @@ -30343,11 +26940,6 @@ paths: 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 @@ -30414,7 +27006,7 @@ paths: 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" @@ -30462,6 +27054,17 @@ paths: $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: @@ -30714,111 +27317,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -30921,7 +27419,7 @@ paths: 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" @@ -31098,111 +27596,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -31305,7 +27698,7 @@ paths: 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" @@ -31369,132 +27762,94 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - put: - tags: - - Network - summary: create or update an existing vlan - description: | - Create or update an existing vlan. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -31518,58 +27873,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) - required: true - schema: - $ref: "#/definitions/vlan" - patch: - tags: - - Network - summary: update an existing vlan - description: | - Update an existing vlan - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -31642,82 +27946,20 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -31830,104 +28072,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -32018,7 +28162,7 @@ paths: 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" @@ -32091,82 +28235,29 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -32341,100 +28432,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -32525,7 +28522,7 @@ paths: 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" @@ -32678,100 +28675,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -32862,7 +28765,7 @@ paths: 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" @@ -32935,84 +28838,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -33091,7 +28916,7 @@ paths: 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" @@ -33152,67 +28977,24 @@ paths: 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: persona-model-id + - name: interface-name in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - - name: persona-model-version + - name: interface-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: macaddr in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: network-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -33509,121 +29291,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -33738,7 +29405,7 @@ paths: 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" @@ -33939,121 +29606,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -34168,7 +29720,7 @@ paths: 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" @@ -34265,105 +29817,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -34466,7 +29919,7 @@ paths: 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" @@ -34551,92 +30004,20 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -34767,114 +30148,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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 @@ -34977,7 +30250,7 @@ paths: 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" @@ -35062,92 +30335,29 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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: @@ -35352,110 +30562,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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 @@ -35558,7 +30664,7 @@ paths: 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" @@ -35735,110 +30841,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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 @@ -35941,7 +30943,7 @@ paths: 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" @@ -36026,94 +31028,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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 @@ -36204,7 +31118,7 @@ paths: 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" @@ -36277,77 +31191,24 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: interface-name 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: interface-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 - - 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}: @@ -36380,79 +31241,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: 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 @@ -36531,7 +31319,7 @@ paths: 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" @@ -36592,67 +31380,19 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version + - name: interface-name in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: interface-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: interface-role in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: @@ -36747,104 +31487,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: vf-module-name - in: query - description: Name of vf-module - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance. - required: false - type: string - - name: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - required: false - type: string put: tags: - Network @@ -36923,7 +31565,7 @@ paths: 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" @@ -36984,67 +31626,44 @@ paths: 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: persona-model-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: persona-model-version in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: + required: false + type: string + - name: contrail-service-instance-fqdn + in: query + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -37157,69 +31776,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -37310,7 +31866,7 @@ paths: 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" @@ -37377,67 +31933,14 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: group-uuid 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: resource-uuid in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -37550,69 +32053,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -37703,7 +32143,7 @@ paths: 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" @@ -37770,67 +32210,14 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: group-uuid 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: resource-uuid in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}: @@ -37857,69 +32244,6 @@ paths: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -37986,7 +32310,7 @@ paths: 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" @@ -38034,6 +32358,77 @@ paths: $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: persona-model-id + in: query + description: + required: false + type: string + - name: persona-model-version + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: @@ -38174,7 +32569,7 @@ paths: 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" @@ -38222,6 +32617,12 @@ paths: $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: @@ -38474,73 +32875,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -38643,7 +32977,7 @@ paths: 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" @@ -38820,73 +33154,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -38989,7 +33256,7 @@ paths: 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" @@ -39074,57 +33341,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -39215,7 +33431,7 @@ paths: 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" @@ -39288,44 +33504,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -39362,142 +33554,82 @@ paths: 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/v9/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/v9/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 @@ -39588,7 +33720,7 @@ paths: 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" @@ -39661,44 +33793,29 @@ paths: 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: @@ -39873,62 +33990,6 @@ paths: 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 @@ -40019,7 +34080,7 @@ paths: 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" @@ -40172,62 +34233,6 @@ paths: 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 @@ -40318,7 +34323,7 @@ paths: 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" @@ -40391,46 +34396,6 @@ paths: 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 @@ -40509,7 +34474,7 @@ paths: 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" @@ -40570,29 +34535,24 @@ paths: 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}: @@ -40619,31 +34579,6 @@ paths: 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 @@ -40710,7 +34645,7 @@ paths: 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" @@ -40758,6 +34693,37 @@ paths: $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: @@ -41102,58 +35068,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -41268,7 +35182,7 @@ paths: 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" @@ -41469,58 +35383,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -41635,7 +35497,7 @@ paths: 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" @@ -41732,42 +35594,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -41870,7 +35696,7 @@ paths: 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" @@ -41955,29 +35781,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -42108,51 +35925,6 @@ paths: 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 @@ -42255,7 +36027,7 @@ paths: 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" @@ -42294,75 +36066,75 @@ paths: type: string example: __INTERFACE-NAME__ - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - example: __PCI-ID__ - - name: resource-version + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: resource-version for concurrency - required: true - type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: - tags: - - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/sriov-vfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: inv-status - 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: @@ -42567,47 +36339,6 @@ paths: 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 @@ -42710,7 +36441,7 @@ paths: 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" @@ -42887,47 +36618,6 @@ paths: 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 @@ -43030,7 +36720,7 @@ paths: 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" @@ -43115,31 +36805,6 @@ paths: 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 @@ -43230,7 +36895,7 @@ paths: 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" @@ -43303,14 +36968,24 @@ paths: 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: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -43343,16 +37018,6 @@ paths: 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 @@ -43431,7 +37096,7 @@ paths: 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" @@ -43492,9 +37157,14 @@ paths: 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: @@ -43791,63 +37461,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -43962,7 +37575,7 @@ paths: 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" @@ -44115,111 +37728,54 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: 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 + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -44334,7 +37890,7 @@ paths: 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" @@ -44431,47 +37987,6 @@ paths: 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-id - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -44574,7 +38089,7 @@ paths: 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" @@ -44659,34 +38174,20 @@ paths: 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-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -44817,56 +38318,6 @@ paths: 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 - 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 @@ -44969,7 +38420,7 @@ paths: 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" @@ -45054,34 +38505,29 @@ paths: 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: @@ -45286,52 +38732,6 @@ paths: 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 @@ -45434,7 +38834,7 @@ paths: 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" @@ -45611,52 +39011,6 @@ paths: 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 @@ -45759,7 +39113,7 @@ paths: 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" @@ -45844,36 +39198,6 @@ paths: 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 @@ -45964,7 +39288,7 @@ paths: 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" @@ -46037,19 +39361,24 @@ paths: 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: + 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: @@ -46082,21 +39411,6 @@ paths: 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 @@ -46175,7 +39489,7 @@ paths: 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" @@ -46236,9 +39550,19 @@ paths: 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: + required: false + type: string + - name: interface-role in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -46265,11 +39589,6 @@ paths: 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 @@ -46336,7 +39655,7 @@ paths: 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" @@ -46384,6 +39703,17 @@ paths: $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: @@ -46458,11 +39788,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -46529,7 +39854,7 @@ paths: 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" @@ -46577,6 +39902,17 @@ paths: $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: @@ -46797,7 +40133,7 @@ paths: 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" @@ -46858,6 +40194,11 @@ paths: 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: @@ -46948,7 +40289,7 @@ paths: 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" @@ -46996,6 +40337,12 @@ paths: $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: @@ -47070,11 +40417,6 @@ paths: 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 @@ -47141,7 +40483,7 @@ paths: 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" @@ -47189,6 +40531,17 @@ paths: $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: @@ -47263,21 +40616,6 @@ paths: 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 @@ -47344,7 +40682,7 @@ paths: 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" @@ -47392,6 +40730,27 @@ paths: $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: @@ -47466,16 +40825,6 @@ paths: 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 @@ -47542,7 +40891,7 @@ paths: 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" @@ -47590,13 +40939,23 @@ paths: $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 definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -47625,14 +40984,16 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -47680,15 +41041,18 @@ definitions: 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 @@ -47740,7 +41104,9 @@ definitions: 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: @@ -47796,22 +41162,24 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -47893,19 +41261,21 @@ definitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -47975,13 +41345,15 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -48047,10 +41419,11 @@ definitions: 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: @@ -48095,10 +41468,12 @@ definitions: 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 @@ -48129,8 +41504,10 @@ definitions: 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: @@ -48155,9 +41532,11 @@ definitions: 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 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 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 @@ -48192,8 +41571,9 @@ definitions: 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 @@ -48252,8 +41632,9 @@ definitions: 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 @@ -48329,9 +41710,11 @@ definitions: 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 @@ -48362,8 +41745,10 @@ definitions: 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 @@ -48393,8 +41778,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -48420,10 +41806,12 @@ definitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -48506,9 +41894,10 @@ definitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -48540,8 +41929,9 @@ definitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -48573,7 +41963,9 @@ definitions: 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: @@ -48656,9 +42048,11 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -48717,12 +42111,14 @@ definitions: 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: @@ -48744,7 +42140,9 @@ definitions: 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: @@ -48786,11 +42184,13 @@ definitions: 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 @@ -48825,28 +42225,29 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -48931,8 +42332,10 @@ definitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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. @@ -49005,9 +42408,10 @@ definitions: 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 @@ -49043,7 +42447,9 @@ definitions: 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 @@ -49086,10 +42492,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -49121,7 +42528,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -49142,11 +42551,13 @@ definitions: 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 @@ -49219,11 +42630,12 @@ definitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -49276,13 +42688,9 @@ definitions: 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: @@ -49327,9 +42735,10 @@ definitions: 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: @@ -49423,18 +42832,20 @@ definitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -49500,10 +42911,12 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -49542,10 +42955,12 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -49584,22 +42999,23 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -49628,6 +43044,7 @@ definitions: 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 @@ -49673,10 +43090,13 @@ definitions: 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. @@ -49707,15 +43127,17 @@ definitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -49763,8 +43185,10 @@ definitions: 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: @@ -49790,8 +43214,10 @@ definitions: 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 @@ -49821,7 +43247,8 @@ definitions: 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: @@ -49847,19 +43274,21 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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, ONE2MANY) + - 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, ONE2MANY) + - 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) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -49945,10 +43374,12 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -49964,13 +43395,15 @@ definitions: 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 @@ -50013,9 +43446,11 @@ definitions: 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 @@ -50041,14 +43476,16 @@ definitions: 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 @@ -50091,12 +43528,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -50146,7 +43586,8 @@ definitions: 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 @@ -50186,10 +43627,11 @@ definitions: 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 @@ -50219,13 +43661,15 @@ definitions: 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: @@ -50346,7 +43790,8 @@ definitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -50370,7 +43815,8 @@ definitions: 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: @@ -50399,8 +43845,9 @@ definitions: 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 @@ -50464,6 +43911,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -50519,9 +43972,10 @@ definitions: 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 @@ -50563,8 +44017,9 @@ definitions: 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 @@ -50659,7 +44114,8 @@ definitions: 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 @@ -50681,15 +44137,17 @@ definitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -50740,7 +44198,9 @@ definitions: 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: @@ -50784,7 +44244,8 @@ definitions: 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: @@ -50810,14 +44271,15 @@ definitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -50854,6 +44316,7 @@ definitions: 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. @@ -50911,9 +44374,11 @@ definitions: 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 @@ -50969,7 +44434,8 @@ definitions: 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: @@ -51003,7 +44469,9 @@ definitions: 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 @@ -51030,19 +44498,20 @@ definitions: 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 @@ -51112,6 +44581,7 @@ definitions: 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. @@ -51158,7 +44628,9 @@ definitions: 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 @@ -51266,7 +44738,8 @@ definitions: 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 @@ -51296,7 +44769,9 @@ definitions: 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 @@ -51325,9 +44800,11 @@ definitions: 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: @@ -51408,7 +44885,9 @@ definitions: 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: @@ -51468,9 +44947,11 @@ definitions: 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 @@ -51516,24 +44997,26 @@ definitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -51612,10 +45095,12 @@ definitions: 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: @@ -51655,9 +45140,11 @@ definitions: 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: @@ -51694,9 +45181,10 @@ definitions: 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: @@ -51734,8 +45222,9 @@ definitions: 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: @@ -51788,8 +45277,10 @@ definitions: 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: @@ -51815,7 +45306,9 @@ definitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -51882,10 +45375,13 @@ definitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -51916,6 +45412,7 @@ definitions: 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 @@ -51945,13 +45442,15 @@ definitions: 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 @@ -51985,7 +45484,9 @@ definitions: 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 - bandwidth-up-wan1 @@ -52051,14 +45552,15 @@ definitions: 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 @@ -52149,12 +45651,15 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -52173,6 +45678,7 @@ definitions: 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. @@ -52220,7 +45726,9 @@ definitions: 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: @@ -52250,10 +45758,11 @@ definitions: 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: @@ -52292,10 +45801,11 @@ definitions: 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: @@ -52334,9 +45844,10 @@ definitions: 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 @@ -52366,15 +45877,17 @@ definitions: 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 properties: @@ -52441,8 +45954,10 @@ definitions: 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 @@ -52481,9 +45996,11 @@ definitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -52511,8 +46028,10 @@ definitions: 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 @@ -52535,7 +46054,9 @@ definitions: 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 @@ -52557,11 +46078,12 @@ definitions: 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 @@ -52615,11 +46137,12 @@ definitions: 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: @@ -52665,9 +46188,11 @@ definitions: description: | VPN binding ###### Related Nodes - - 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) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -52713,19 +46238,20 @@ definitions: 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 @@ -52750,8 +46276,10 @@ definitions: 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. @@ -52779,10 +46307,11 @@ definitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -52820,12 +46349,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -52854,14 +46377,16 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -52898,15 +46423,18 @@ patchDefinitions: 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 @@ -52951,7 +46479,9 @@ patchDefinitions: 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: @@ -53000,22 +46530,24 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -53054,19 +46586,21 @@ patchDefinitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -53100,13 +46634,15 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -53161,10 +46697,11 @@ patchDefinitions: 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: @@ -53183,10 +46720,12 @@ patchDefinitions: 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 @@ -53207,8 +46746,10 @@ patchDefinitions: 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: @@ -53226,9 +46767,11 @@ patchDefinitions: 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 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 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 @@ -53256,8 +46799,9 @@ patchDefinitions: 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 @@ -53298,8 +46842,9 @@ patchDefinitions: 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 @@ -53368,9 +46913,11 @@ patchDefinitions: 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 @@ -53391,8 +46938,10 @@ patchDefinitions: 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 @@ -53415,8 +46964,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -53433,10 +46983,12 @@ patchDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -53512,9 +47064,10 @@ patchDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -53537,8 +47090,9 @@ patchDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -53561,7 +47115,9 @@ patchDefinitions: 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: @@ -53637,9 +47193,11 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -53691,12 +47249,14 @@ patchDefinitions: 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: @@ -53711,7 +47271,9 @@ patchDefinitions: 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: @@ -53746,11 +47308,13 @@ patchDefinitions: 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 @@ -53771,28 +47335,29 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -53877,8 +47442,10 @@ patchDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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 @@ -53891,9 +47458,10 @@ patchDefinitions: 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 @@ -53922,7 +47490,9 @@ patchDefinitions: 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 @@ -53958,10 +47528,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -53982,7 +47553,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -53996,11 +47569,13 @@ patchDefinitions: 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 @@ -54062,11 +47637,12 @@ patchDefinitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -54112,13 +47688,9 @@ patchDefinitions: 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: @@ -54163,9 +47735,10 @@ patchDefinitions: 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: @@ -54248,18 +47821,20 @@ patchDefinitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -54302,10 +47877,12 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -54331,10 +47908,12 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -54360,22 +47939,23 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -54404,6 +47984,7 @@ patchDefinitions: 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 @@ -54421,15 +48002,17 @@ patchDefinitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -54451,8 +48034,10 @@ patchDefinitions: 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: @@ -54471,8 +48056,10 @@ patchDefinitions: 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 @@ -54495,7 +48082,8 @@ patchDefinitions: 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: @@ -54514,19 +48102,21 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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, ONE2MANY) + - 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, ONE2MANY) + - 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) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -54569,10 +48159,12 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -54585,13 +48177,15 @@ patchDefinitions: 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 @@ -54623,9 +48217,11 @@ patchDefinitions: 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 @@ -54648,14 +48244,16 @@ patchDefinitions: 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 @@ -54681,12 +48279,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -54721,7 +48322,8 @@ patchDefinitions: 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 @@ -54754,10 +48356,11 @@ patchDefinitions: 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 @@ -54777,13 +48380,15 @@ patchDefinitions: 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: @@ -54882,7 +48487,8 @@ patchDefinitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -54899,7 +48505,8 @@ patchDefinitions: 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: @@ -54921,8 +48528,9 @@ patchDefinitions: 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 @@ -54963,6 +48571,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -55018,9 +48632,10 @@ patchDefinitions: 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 @@ -55055,8 +48670,9 @@ patchDefinitions: 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 @@ -55135,7 +48751,8 @@ patchDefinitions: 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 @@ -55150,15 +48767,17 @@ patchDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -55198,7 +48817,9 @@ patchDefinitions: 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: @@ -55235,7 +48856,8 @@ patchDefinitions: 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: @@ -55254,14 +48876,15 @@ patchDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -55298,6 +48921,7 @@ patchDefinitions: 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. @@ -55334,9 +48958,11 @@ patchDefinitions: 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 @@ -55363,7 +48989,8 @@ patchDefinitions: 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: @@ -55390,7 +49017,9 @@ patchDefinitions: 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 @@ -55415,19 +49044,20 @@ patchDefinitions: 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 @@ -55497,6 +49127,7 @@ patchDefinitions: 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. @@ -55519,7 +49150,9 @@ patchDefinitions: 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 @@ -55619,7 +49252,8 @@ patchDefinitions: 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 @@ -55642,7 +49276,9 @@ patchDefinitions: 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 @@ -55664,9 +49300,11 @@ patchDefinitions: 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: @@ -55736,7 +49374,9 @@ patchDefinitions: 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: @@ -55779,9 +49419,11 @@ patchDefinitions: 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 @@ -55820,24 +49462,26 @@ patchDefinitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -55895,10 +49539,12 @@ patchDefinitions: 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: @@ -55927,9 +49573,11 @@ patchDefinitions: 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: @@ -55955,9 +49603,10 @@ patchDefinitions: 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: @@ -55984,8 +49633,9 @@ patchDefinitions: 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: @@ -56031,8 +49681,10 @@ patchDefinitions: 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: @@ -56051,7 +49703,9 @@ patchDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -56108,10 +49762,13 @@ patchDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -56142,6 +49799,7 @@ patchDefinitions: 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 @@ -56164,13 +49822,15 @@ patchDefinitions: 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 @@ -56193,7 +49853,9 @@ patchDefinitions: 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 - bandwidth-up-wan1 @@ -56252,14 +49914,15 @@ patchDefinitions: 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 @@ -56325,12 +49988,15 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -56349,6 +50015,7 @@ patchDefinitions: 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 @@ -56361,7 +50028,9 @@ patchDefinitions: 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: @@ -56384,10 +50053,11 @@ patchDefinitions: 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: @@ -56413,10 +50083,11 @@ patchDefinitions: 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: @@ -56442,9 +50113,10 @@ patchDefinitions: 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 @@ -56467,15 +50139,17 @@ patchDefinitions: 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 properties: @@ -56509,8 +50183,10 @@ patchDefinitions: 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 @@ -56542,9 +50218,11 @@ patchDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -56572,8 +50250,10 @@ patchDefinitions: 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 @@ -56589,7 +50269,9 @@ patchDefinitions: 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 @@ -56604,11 +50286,12 @@ patchDefinitions: 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 @@ -56655,11 +50338,12 @@ patchDefinitions: 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: @@ -56690,9 +50374,11 @@ patchDefinitions: description: | VPN binding ###### Related Nodes - - 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) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -56730,19 +50416,20 @@ patchDefinitions: 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 @@ -56767,8 +50454,10 @@ patchDefinitions: 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. @@ -56781,10 +50470,11 @@ patchDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -56815,12 +50505,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -56849,14 +50533,16 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -56904,15 +50590,18 @@ getDefinitions: 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 @@ -56964,7 +50653,9 @@ getDefinitions: 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: @@ -57020,22 +50711,24 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM 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,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -57117,19 +50810,21 @@ getDefinitions: 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 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,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 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,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -57199,13 +50894,15 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -57271,10 +50968,11 @@ getDefinitions: 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: @@ -57319,10 +51017,12 @@ getDefinitions: 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 @@ -57353,8 +51053,10 @@ getDefinitions: 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: @@ -57379,9 +51081,11 @@ getDefinitions: 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 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 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 @@ -57416,8 +51120,9 @@ getDefinitions: 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 @@ -57476,8 +51181,9 @@ getDefinitions: 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 @@ -57553,9 +51259,11 @@ getDefinitions: 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 @@ -57586,8 +51294,10 @@ getDefinitions: 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 @@ -57617,8 +51327,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -57644,10 +51355,12 @@ getDefinitions: 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) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -57730,9 +51443,10 @@ getDefinitions: 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -57764,8 +51478,9 @@ getDefinitions: 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -57797,7 +51512,9 @@ getDefinitions: 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: @@ -57880,9 +51597,11 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -57941,12 +51660,14 @@ getDefinitions: 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: @@ -57968,7 +51689,9 @@ getDefinitions: 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: @@ -58010,11 +51733,13 @@ getDefinitions: 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 @@ -58049,28 +51774,29 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, 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 pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + - TO availability-zone( generic-vnf Uses availability-zone, 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 pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM 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 logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -58155,8 +51881,10 @@ getDefinitions: description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases 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. @@ -58229,9 +51957,10 @@ getDefinitions: 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 @@ -58267,7 +51996,9 @@ getDefinitions: 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 @@ -58310,10 +52041,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - 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 @@ -58345,7 +52077,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - 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: @@ -58366,11 +52100,13 @@ getDefinitions: 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 @@ -58443,11 +52179,12 @@ getDefinitions: 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance 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 pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + required: - id - description @@ -58500,13 +52237,9 @@ getDefinitions: 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: @@ -58551,9 +52284,10 @@ getDefinitions: 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: @@ -58647,18 +52381,20 @@ getDefinitions: 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 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 l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name properties: @@ -58724,10 +52460,12 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -58766,10 +52504,12 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - 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 l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -58808,22 +52548,23 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM 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 @@ -58852,6 +52593,7 @@ getDefinitions: 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 @@ -58897,10 +52639,13 @@ getDefinitions: 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. @@ -58931,15 +52676,17 @@ getDefinitions: 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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name properties: @@ -58987,8 +52734,10 @@ getDefinitions: 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: @@ -59014,8 +52763,10 @@ getDefinitions: 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 @@ -59045,7 +52796,8 @@ getDefinitions: 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: @@ -59071,19 +52823,21 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM 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, ONE2MANY) + - 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, ONE2MANY) + - 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) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, ONE2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - link-type @@ -59169,10 +52923,12 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -59188,13 +52944,15 @@ getDefinitions: 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 @@ -59237,9 +52995,11 @@ getDefinitions: 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 @@ -59265,14 +53025,16 @@ getDefinitions: 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 @@ -59315,12 +53077,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -59370,7 +53135,8 @@ getDefinitions: 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 @@ -59410,10 +53176,11 @@ getDefinitions: 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 @@ -59443,13 +53210,15 @@ getDefinitions: 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: @@ -59570,7 +53339,8 @@ getDefinitions: network-policy: description: | ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -59594,7 +53364,8 @@ getDefinitions: 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: @@ -59623,8 +53394,9 @@ getDefinitions: 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 @@ -59688,6 +53460,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -59743,9 +53521,10 @@ getDefinitions: 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 @@ -59787,8 +53566,9 @@ getDefinitions: 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 @@ -59883,7 +53663,8 @@ getDefinitions: 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 @@ -59905,15 +53686,17 @@ getDefinitions: 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) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE - - 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) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name properties: @@ -59964,7 +53747,9 @@ getDefinitions: 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: @@ -60008,7 +53793,8 @@ getDefinitions: 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: @@ -60034,14 +53820,15 @@ getDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. ###### 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 logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -60078,6 +53865,7 @@ getDefinitions: 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. @@ -60135,9 +53923,11 @@ getDefinitions: 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 @@ -60193,7 +53983,8 @@ getDefinitions: 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: @@ -60227,7 +54018,9 @@ getDefinitions: 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 @@ -60254,19 +54047,20 @@ getDefinitions: 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 @@ -60336,6 +54130,7 @@ getDefinitions: 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. @@ -60382,7 +54177,9 @@ getDefinitions: 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 @@ -60494,7 +54291,8 @@ getDefinitions: 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 @@ -60524,7 +54322,9 @@ getDefinitions: 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 @@ -60553,9 +54353,11 @@ getDefinitions: 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: @@ -60636,7 +54438,9 @@ getDefinitions: 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: @@ -60696,9 +54500,11 @@ getDefinitions: 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 @@ -60744,24 +54550,26 @@ getDefinitions: 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 allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - 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 service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO 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 service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id properties: @@ -60840,10 +54648,12 @@ getDefinitions: 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: @@ -60883,9 +54693,11 @@ getDefinitions: 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: @@ -60922,9 +54734,10 @@ getDefinitions: 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: @@ -60962,8 +54775,9 @@ getDefinitions: 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: @@ -61016,8 +54830,10 @@ getDefinitions: 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: @@ -61043,7 +54859,9 @@ getDefinitions: 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 l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -61110,10 +54928,13 @@ getDefinitions: 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) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -61144,6 +54965,7 @@ getDefinitions: 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 @@ -61173,13 +54995,15 @@ getDefinitions: 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 @@ -61213,7 +55037,9 @@ getDefinitions: 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 - bandwidth-up-wan1 @@ -61279,14 +55105,15 @@ getDefinitions: 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 @@ -61377,12 +55204,15 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -61401,6 +55231,7 @@ getDefinitions: 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. @@ -61448,7 +55279,9 @@ getDefinitions: 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: @@ -61478,10 +55311,11 @@ getDefinitions: 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: @@ -61520,10 +55354,11 @@ getDefinitions: 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: @@ -61562,9 +55397,10 @@ getDefinitions: 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 @@ -61594,15 +55430,17 @@ getDefinitions: 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 properties: @@ -61669,8 +55507,10 @@ getDefinitions: 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 @@ -61709,9 +55549,11 @@ getDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - vnfc-function-code @@ -61739,8 +55581,10 @@ getDefinitions: 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 @@ -61763,7 +55607,9 @@ getDefinitions: 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 @@ -61785,11 +55631,12 @@ getDefinitions: 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 @@ -61843,11 +55690,12 @@ getDefinitions: 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: @@ -61893,9 +55741,11 @@ getDefinitions: description: | VPN binding ###### Related Nodes - - 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) - - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + + -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -61941,19 +55791,20 @@ getDefinitions: 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 @@ -61978,8 +55829,10 @@ getDefinitions: 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. @@ -62007,10 +55860,11 @@ getDefinitions: 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) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name -- cgit 1.2.3-korg