X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v10.yaml;fp=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v10.yaml;h=797e5d9b2ee0db3732e1e2202a6860b03a63728e;hb=f1a8fb1bc04f5d685f2b31d35db605f6fa054f60;hp=ac8969de7726794019a6d7c8efc5e214749ede82;hpb=b1264ad4012f67664d71982a0eaad7e9bcce34f4;p=aai%2Faai-common.git 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