X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v11.yaml;fp=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v11.yaml;h=e34cbab88f0703713e6f761e512b5a95ad799ebe;hb=f1a8fb1bc04f5d685f2b31d35db605f6fa054f60;hp=10d062683760c194ca9eff649844ec31f1d08af9;hpb=b1264ad4012f67664d71982a0eaad7e9bcce34f4;p=aai%2Faai-common.git diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml index 10d06268..e34cbab8 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml @@ -141,21 +141,6 @@ paths: required: true type: string example: __AVAILABILITY-ZONE-NAME__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string put: tags: - CloudInfrastructure @@ -246,7 +231,7 @@ paths: example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: ctag-pool object that needs to be created or updated. + description: ctag-pool object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ctag-pool" @@ -313,19 +298,9 @@ paths: required: true type: string example: __PHYSICAL-LOCATION-ID__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url + - name: availability-zone-name in: query - description: URL of the keystone identity service + description: required: false type: string /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: @@ -402,21 +377,6 @@ paths: required: true type: string example: __PHYSICAL-LOCATION-ID__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string put: tags: - CloudInfrastructure @@ -483,7 +443,7 @@ paths: example: __PHYSICAL-LOCATION-ID__ - name: body in: body - description: complex object that needs to be created or updated. + description: complex object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/complex" @@ -531,6 +491,27 @@ paths: $ref: "#/getDefinitions/complexes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: query + description: + required: false + type: string + - name: data-center-code + in: query + description: + required: false + type: string + - name: complex-name + in: query + description: + required: false + type: string + - name: identity-url + in: query + description: + required: false + type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: put: tags: @@ -641,31 +622,6 @@ paths: required: true type: string example: __VOLUME-GROUP-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: volume-group-name - in: query - description: Name of the volume group. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this volume-group - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string put: tags: - CloudInfrastructure @@ -756,7 +712,7 @@ paths: example: __VOLUME-GROUP-ID__ - name: body in: body - description: volume-group object that needs to be created or updated. + description: volume-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/volume-group" @@ -829,214 +785,32 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: - get: - tags: - - CloudInfrastructure - summary: returns volume - description: returns volume - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/volume" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context + - name: volume-group-id in: query - description: This field will store the tenant context. + description: required: false type: string - - name: vserver-name + - name: volume-group-name in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: heat-stack-id in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: vnf-type in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing volume - description: | - Create or update an existing volume. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml @@ -1079,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: - $ref: "#/definitions/volume" - patch: + $ref: "#/definitions/relationship" + delete: tags: - CloudInfrastructure - summary: update an existing volume - description: | - Update an existing volume - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml @@ -1140,25 +903,21 @@ paths: required: true type: string example: __VOLUME-ID__ - - name: body - in: body - description: volume object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/volume" - delete: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: + get: tags: - CloudInfrastructure - summary: delete an existing volume - description: delete an existing volume - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume - consumes: - - application/json - - application/xml + summary: returns volume + description: returns volume + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1192,26 +951,22 @@ paths: required: true type: string example: __VOLUME-ID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: - get: + put: tags: - CloudInfrastructure - summary: returns volumes - description: returns volumes - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes + summary: create or update an existing volume + description: | + Create or update an existing volume. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1239,55 +994,35 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: - put: + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/volume" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + summary: update an existing volume + description: | + Update an existing volume + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml @@ -1322,18 +1057,24 @@ paths: required: true type: string example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + description: volume object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/volume" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + summary: delete an existing volume + description: delete an existing volume + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml @@ -1368,19 +1109,32 @@ paths: required: true type: string example: __VSERVER-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: + get: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns volumes + description: returns volumes + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1408,21 +1162,54 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: interface-name + - name: volume-id + in: query + description: + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner in: path - description: Name given to the interface + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - example: __INTERFACE-NAME__ - - name: vlan-interface + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: String that identifies the interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - example: __VLAN-INTERFACE__ + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1431,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1466,24 +1253,12 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1530,15 +1305,9 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1547,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1594,27 +1363,19 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1660,91 +1421,130 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vserver-name - in: query - description: Name of vserver - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure @@ -1883,7 +1683,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -2132,91 +1932,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -2355,7 +2070,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -2476,75 +2191,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -2671,7 +2317,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -2780,62 +2426,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -3002,84 +2606,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -3206,7 +2732,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -3315,62 +2841,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name + - name: pci-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: vf-vlan-filter in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: vf-mac-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -3635,80 +3128,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -3835,7 +3254,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -4060,80 +3479,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -4260,7 +3605,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -4369,64 +3714,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -4541,7 +3828,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -4638,49 +3925,26 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context + - name: interface-name in: query - description: This field will store the tenant context. + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -4723,49 +3987,6 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean put: tags: - CloudInfrastructure @@ -4868,7 +4089,7 @@ paths: example: __VSERVER-ID__ - name: body in: body - description: vserver object that needs to be created or updated. + description: vserver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vserver" @@ -4953,26 +4174,36 @@ paths: required: true type: string example: __TENANT-ID__ - - name: cloud-type + - name: vserver-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vserver-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - - name: tenant-name + - name: vserver-name2 in: query - description: Readable name of tenant + description: required: false type: string - - name: tenant-context + - name: prov-status in: query - description: This field will store the tenant context. + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -5083,26 +4314,6 @@ paths: required: true type: string example: __TENANT-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string put: tags: - CloudInfrastructure @@ -5193,7 +4404,7 @@ paths: example: __TENANT-ID__ - name: body in: body - description: tenant object that needs to be created or updated. + description: tenant object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/tenant" @@ -5266,14 +4477,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: tenant-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: tenant-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: tenant-context + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -5386,21 +4602,6 @@ paths: required: true type: string example: __FLAVOR-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: flavor-name - in: query - description: Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -5491,7 +4692,7 @@ paths: example: __FLAVOR-ID__ - name: body in: body - description: flavor object that needs to be created or updated. + description: flavor object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/flavor" @@ -5564,14 +4765,14 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: flavor-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: flavor-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: @@ -5684,26 +4885,6 @@ paths: required: true type: string example: __GROUP-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: group-type - in: query - description: Group type - the type of group this instance refers to - required: false - type: string - - name: group-name - in: query - description: Group name - name assigned to the group - required: false - type: string put: tags: - CloudInfrastructure @@ -5794,7 +4975,7 @@ paths: example: __GROUP-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. + description: group-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/group-assignment" @@ -5867,14 +5048,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: group-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: group-type + in: query + description: + required: false + type: string + - name: group-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: @@ -5987,41 +5173,6 @@ paths: required: true type: string example: __SNAPSHOT-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: snapshot-name - in: query - description: Snapshot name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string - - name: prev-snapshot-id - in: query - description: This field contains the UUID of the previous snapshot (if any). - required: false - type: string put: tags: - CloudInfrastructure @@ -6112,7 +5263,7 @@ paths: example: __SNAPSHOT-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. + description: snapshot object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/snapshot" @@ -6185,14 +5336,34 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: snapshot-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: snapshot-name + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: + required: false + type: string + - name: prev-snapshot-id in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -6310,36 +5481,6 @@ paths: required: true type: string example: __METANAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - CloudInfrastructure @@ -6440,7 +5581,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -6524,34 +5665,9 @@ paths: required: true type: string example: __IMAGE-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version + - name: metaname in: query - description: The version of the application. + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: @@ -6590,36 +5706,6 @@ paths: required: true type: string example: __IMAGE-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - CloudInfrastructure @@ -6710,7 +5796,7 @@ paths: example: __IMAGE-ID__ - name: body in: body - description: image object that needs to be created or updated. + description: image object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/image" @@ -6783,14 +5869,29 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: image-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: image-name + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: application-version + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -6903,21 +6004,6 @@ paths: required: true type: string example: __SWITCH-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vcenter-url - in: query - description: URL used to reach the vcenter - required: false - type: string put: tags: - CloudInfrastructure @@ -7008,7 +6094,7 @@ paths: example: __SWITCH-NAME__ - name: body in: body - description: dvs-switch object that needs to be created or updated. + description: dvs-switch object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/dvs-switch" @@ -7081,14 +6167,14 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: switch-name in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vcenter-url in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: @@ -7201,27 +6287,6 @@ paths: required: true type: string example: __NETWORK-UUID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: network-name - in: query - description: Name of the network. - required: false - type: string - - name: cvlan-tag - in: query - description: cvlan-id - required: false - type: integer - format: int64 put: tags: - CloudInfrastructure @@ -7312,7 +6377,7 @@ paths: example: __NETWORK-UUID__ - name: body in: body - description: oam-network object that needs to be created or updated. + description: oam-network object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/oam-network" @@ -7385,16 +6450,22 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: network-uuid in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: network-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string + - name: cvlan-tag + in: query + description: + required: false + type: integer + format: int64 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: put: tags: @@ -7505,16 +6576,6 @@ paths: required: true type: string example: __AVAILABILITY-ZONE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string put: tags: - CloudInfrastructure @@ -7605,7 +6666,7 @@ paths: example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: availability-zone object that needs to be created or updated. + description: availability-zone object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/availability-zone" @@ -7678,14 +6739,9 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type + - name: availability-zone-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: @@ -7860,205 +6916,190 @@ paths: required: true type: string example: __ESR-SYSTEM-INFO-ID__ - - name: cloud-type + put: + tags: + - CloudInfrastructure + summary: create or update an existing esr-system-info + description: | + Create or update an existing esr-system-info. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: body + in: body + description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) + required: true + schema: + $ref: "#/definitions/esr-system-info" + patch: + tags: + - CloudInfrastructure + summary: update an existing esr-system-info + description: | + Update an existing esr-system-info + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: body + in: body + description: esr-system-info object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/esr-system-info" + delete: + tags: + - CloudInfrastructure + summary: delete an existing esr-system-info + description: delete an existing esr-system-info + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ + - name: resource-version in: query - description: Type of the cloud (e.g., openstack) - required: false + description: resource-version for concurrency + required: true type: string - - name: owner-defined-type + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list: + get: + tags: + - CloudInfrastructure + summary: returns esr-system-info-list + description: returns esr-system-info-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/esr-system-info-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - name: system-name in: query - description: name of external system. + description: required: false type: string - name: system-type in: query - description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + description: required: false type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing esr-system-info - description: | - Create or update an existing esr-system-info. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-ID__ - - name: body - in: body - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) - required: true - schema: - $ref: "#/definitions/esr-system-info" - patch: - tags: - - CloudInfrastructure - summary: update an existing esr-system-info - description: | - Update an existing esr-system-info - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-ID__ - - name: body - in: body - description: esr-system-info object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/esr-system-info" - delete: - tags: - - CloudInfrastructure - summary: delete an existing esr-system-info - description: delete an existing esr-system-info - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: esr-system-info-id - in: path - description: Unique ID of esr system info. - required: true - type: string - example: __ESR-SYSTEM-INFO-ID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list: - get: - tags: - - CloudInfrastructure - summary: returns esr-system-info-list - description: returns esr-system-info-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/esr-system-info-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -8163,32 +7204,6 @@ paths: required: true type: string example: __VIP-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8279,7 +7294,7 @@ paths: example: __VIP-IPV4-ADDRESS__ - name: body in: body - description: vip-ipv4-address-list object that needs to be created or updated. + description: vip-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vip-ipv4-address-list" @@ -8432,32 +7447,6 @@ paths: required: true type: string example: __VIP-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8548,7 +7537,7 @@ paths: example: __VIP-IPV6-ADDRESS__ - name: body in: body - description: vip-ipv6-address-list object that needs to be created or updated. + description: vip-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vip-ipv6-address-list" @@ -8621,16 +7610,6 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string put: tags: - CloudInfrastructure @@ -8709,7 +7688,7 @@ paths: example: __CLOUD-REGION-ID__ - name: body in: body - description: cloud-region object that needs to be created or updated. + description: cloud-region object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/cloud-region" @@ -8763,6 +7742,27 @@ paths: $ref: "#/getDefinitions/cloud-regions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: query + description: + required: false + type: string + - name: cloud-region-id + in: query + description: + required: false + type: string + - name: cloud-type + in: query + description: + required: false + type: string + - name: owner-defined-type + in: query + description: + required: false + type: string /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: put: tags: @@ -8903,7 +7903,7 @@ paths: example: __NM-PROFILE-NAME__ - name: body in: body - description: network-profile object that needs to be created or updated. + description: network-profile object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/network-profile" @@ -8951,6 +7951,12 @@ paths: $ref: "#/getDefinitions/network-profiles" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: query + description: + required: false + type: string /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: put: tags: @@ -9173,30 +8179,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - CloudInfrastructure @@ -9287,7 +8269,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -9360,28 +8342,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -9616,72 +8579,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -9796,7 +8693,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -9997,72 +8894,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -10177,7 +9008,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -10274,168 +9105,118 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: tags: - CloudInfrastructure - summary: create or update an existing vlan - description: | - Create or update an existing vlan. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) - required: true - schema: - $ref: "#/definitions/vlan" - patch: - tags: - - CloudInfrastructure - summary: update an existing vlan - description: | - Update an existing vlan - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vlan" - delete: - tags: - - CloudInfrastructure - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -10511,43 +9292,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -10678,65 +9436,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -10839,7 +9538,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -10924,43 +9623,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: pci-id in: query - description: alternative pserver name + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -11165,61 +9850,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11322,7 +9952,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -11499,61 +10129,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -11656,7 +10231,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -11741,45 +10316,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -11870,7 +10406,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -11943,28 +10479,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: interface-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: macaddr in: query - description: alternative pserver name + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: @@ -11997,30 +10529,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - CloudInfrastructure @@ -12099,7 +10607,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -12160,23 +10668,14 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: prov-status in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -12473,77 +10972,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -12658,7 +11086,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -12859,77 +11287,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -13044,7 +11401,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -13141,61 +11498,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -13298,7 +11600,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -13383,48 +11685,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -13555,70 +11829,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -13721,7 +11931,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -13806,48 +12016,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -14052,66 +12243,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -14214,7 +12345,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -14391,66 +12522,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -14553,7 +12624,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -14638,50 +12709,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -14772,7 +12799,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -14845,33 +12872,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: interface-id in: query - description: alternative pserver name + description: required: false type: string - - name: interface-id + - name: macaddr in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: @@ -14904,35 +12922,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - CloudInfrastructure @@ -15011,7 +13000,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -15072,23 +13061,19 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: interface-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: interface-role in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}: @@ -15115,25 +13100,6 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string put: tags: - CloudInfrastructure @@ -15200,7 +13166,7 @@ paths: example: __HOSTNAME__ - name: body in: body - description: pserver object that needs to be created or updated. + description: pserver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/pserver" @@ -15248,6 +13214,32 @@ paths: $ref: "#/getDefinitions/pservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: query + description: + required: false + type: string + - name: inv-status + in: query + description: + required: false + type: string + - name: pserver-id + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: pserver-name2 + in: query + description: + required: false + type: string /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: put: tags: @@ -15322,11 +13314,6 @@ paths: required: true type: string example: __VDC-ID__ - - name: vdc-name - in: query - description: Name of the virtual data center - required: false - type: string put: tags: - CloudInfrastructure @@ -15393,7 +13380,7 @@ paths: example: __VDC-ID__ - name: body in: body - description: virtual-data-center object that needs to be created or updated. + description: virtual-data-center object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/virtual-data-center" @@ -15441,6 +13428,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -15520,26 +13518,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -15616,7 +13594,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -15676,24 +13654,9 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: metaname in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /business/connectors/connector/{resource-instance-id}: @@ -15720,26 +13683,6 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -15806,7 +13749,7 @@ paths: example: __RESOURCE-INSTANCE-ID__ - name: body in: body - description: connector object that needs to be created or updated. + description: connector object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/connector" @@ -15854,6 +13797,32 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: put: tags: @@ -15969,171 +13938,116 @@ paths: required: true type: string example: __METANAME__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Business + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true type: string - put: + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: tags: - Business - summary: create or update an existing metadatum - description: | - Create or update an existing metadatum. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: metaname - in: path - required: true - type: string - example: __METANAME__ - - name: body - in: body - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) - required: true - schema: - $ref: "#/definitions/metadatum" - patch: - tags: - - Business - summary: update an existing metadatum - description: | - Update an existing metadatum - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: metaname - in: path - required: true - type: string - example: __METANAME__ - - name: body - in: body - description: metadatum object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/metadatum" - delete: - tags: - - Business - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json - application/xml @@ -16208,59 +14122,9 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status + - name: metaname in: query - description: Orchestration status of this service. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship: @@ -16409,81 +14273,6 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role - in: query - description: role in the network that this resource will be providing. - required: false - type: string put: tags: - Business @@ -16598,7 +14387,7 @@ paths: example: __ID__ - name: body in: body - description: tunnel-xconnect object that needs to be created or updated. + description: tunnel-xconnect object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/tunnel-xconnect" @@ -16695,79 +14484,9 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role + - name: id in: query - description: role in the network that this resource will be providing. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship: @@ -16898,81 +14617,6 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role - in: query - description: role in the network that this resource will be providing. - required: false - type: string put: tags: - Business @@ -17075,7 +14719,7 @@ paths: example: __ID__ - name: body in: body - description: allotted-resource object that needs to be created or updated. + description: allotted-resource object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/allotted-resource" @@ -17160,59 +14804,29 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context + - name: id in: query - description: This field will store the workload context assigned to the service-instance. + description: required: false type: string - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: service-instance-location-id + - name: type in: query - description: An identifier that customers assign to the location where this service is being used. + description: required: false type: string - - name: orchestration-status + - name: role in: query - description: Orchestration status of this service. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: @@ -17251,61 +14865,6 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string put: tags: - Business @@ -17396,7 +14955,7 @@ paths: example: __SERVICE-INSTANCE-ID__ - name: body in: body - description: service-instance object that needs to be created or updated. + description: service-instance object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-instance" @@ -17469,14 +15028,54 @@ paths: required: true type: string example: __SERVICE-TYPE__ - - name: subscriber-name + - name: service-instance-id in: query - description: Subscriber name, an alternate way to retrieve a customer. + description: required: false type: string - - name: subscriber-type + - name: service-instance-name + in: query + description: + required: false + type: string + - name: environment-context + in: query + description: + required: false + type: string + - name: workload-context + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -17571,16 +15170,6 @@ paths: required: true type: string example: __SERVICE-TYPE__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string put: tags: - Business @@ -17659,7 +15248,7 @@ paths: example: __SERVICE-TYPE__ - name: body in: body - description: service-subscription object that needs to be created or updated. + description: service-subscription object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-subscription" @@ -17720,14 +15309,9 @@ paths: required: true type: string example: __GLOBAL-CUSTOMER-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type + - name: service-type in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: required: false type: string /business/customers/customer/{global-customer-id}/relationship-list/relationship: @@ -17804,16 +15388,6 @@ paths: required: true type: string example: __GLOBAL-CUSTOMER-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string put: tags: - Business @@ -17880,7 +15454,7 @@ paths: example: __GLOBAL-CUSTOMER-ID__ - name: body in: body - description: customer object that needs to be created or updated. + description: customer object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/customer" @@ -17928,6 +15502,22 @@ paths: $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: put: tags: @@ -18068,7 +15658,7 @@ paths: example: __LINE-OF-BUSINESS-NAME__ - name: body in: body - description: line-of-business object that needs to be created or updated. + description: line-of-business object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/line-of-business" @@ -18116,6 +15706,12 @@ paths: $ref: "#/getDefinitions/lines-of-business" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: query + description: + required: false + type: string /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: put: tags: @@ -18256,7 +15852,7 @@ paths: example: __OWNING-ENTITY-ID__ - name: body in: body - description: owning-entity object that needs to be created or updated. + description: owning-entity object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/owning-entity" @@ -18304,6 +15900,12 @@ paths: $ref: "#/getDefinitions/owning-entities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: query + description: + required: false + type: string /business/platforms/platform/{platform-name}/relationship-list/relationship: put: tags: @@ -18444,7 +16046,7 @@ paths: example: __PLATFORM-NAME__ - name: body in: body - description: platform object that needs to be created or updated. + description: platform object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/platform" @@ -18492,6 +16094,12 @@ paths: $ref: "#/getDefinitions/platforms" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: query + description: + required: false + type: string /business/projects/project/{project-name}/relationship-list/relationship: put: tags: @@ -18632,7 +16240,7 @@ paths: example: __PROJECT-NAME__ - name: body in: body - description: project object that needs to be created or updated. + description: project object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/project" @@ -18680,6 +16288,12 @@ paths: $ref: "#/getDefinitions/projects" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: query + description: + required: false + type: string /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: @@ -18754,21 +16368,6 @@ paths: required: true type: string example: __VNF-IMAGE-UUID__ - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -18835,7 +16434,7 @@ paths: example: __VNF-IMAGE-UUID__ - name: body in: body - description: vnf-image object that needs to be created or updated. + description: vnf-image object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vnf-image" @@ -18883,6 +16482,27 @@ paths: $ref: "#/getDefinitions/vnf-images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: + required: false + type: string /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: put: tags: @@ -18957,11 +16577,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19028,7 +16643,7 @@ paths: example: __SERVICE-ID__ - name: body in: body - description: service object that needs to be created or updated. + description: service object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service" @@ -19076,6 +16691,17 @@ paths: $ref: "#/getDefinitions/services" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: query + description: + required: false + type: string + - name: service-description + in: query + description: + required: false + type: string /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: put: tags: @@ -19246,7 +16872,7 @@ paths: example: __VNF-TYPE__ - name: body in: body - description: service-capability object that needs to be created or updated. + description: service-capability object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-capability" @@ -19300,6 +16926,17 @@ paths: $ref: "#/getDefinitions/service-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship: put: tags: @@ -19452,21 +17089,6 @@ paths: required: true type: string example: __ELEMENT-CHOICE-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19585,7 +17207,7 @@ paths: example: __ELEMENT-CHOICE-SET-UUID__ - name: body in: body - description: element-choice-set object that needs to be created or updated. + description: element-choice-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/element-choice-set" @@ -19687,19 +17309,9 @@ paths: required: true type: string example: __CONSTRAINED-ELEMENT-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: element-choice-set-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship: @@ -19839,21 +17451,6 @@ paths: required: true type: string example: __CONSTRAINED-ELEMENT-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -19962,7 +17559,7 @@ paths: example: __CONSTRAINED-ELEMENT-SET-UUID__ - name: body in: body - description: constrained-element-set object that needs to be created or updated. + description: constrained-element-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/constrained-element-set" @@ -20054,19 +17651,9 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: constrained-element-set-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}: @@ -20109,21 +17696,6 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20222,7 +17794,7 @@ paths: example: __MODEL-CONSTRAINT-UUID__ - name: body in: body - description: model-constraint object that needs to be created or updated. + description: model-constraint object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model-constraint" @@ -20304,19 +17876,9 @@ paths: required: true type: string example: __MODEL-ELEMENT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: model-constraint-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: @@ -20426,21 +17988,6 @@ paths: required: true type: string example: __MODEL-ELEMENT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20529,7 +18076,7 @@ paths: example: __MODEL-ELEMENT-UUID__ - name: body in: body - description: model-element object that needs to be created or updated. + description: model-element object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model-element" @@ -20601,19 +18148,9 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: model-element-uuid in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: @@ -20651,21 +18188,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20754,7 +18276,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -20826,19 +18348,9 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: metaname in: query - description: Version + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: @@ -20933,21 +18445,6 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21026,7 +18523,7 @@ paths: example: __MODEL-VERSION-ID__ - name: body in: body - description: model-ver object that needs to be created or updated. + description: model-ver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model-ver" @@ -21087,9 +18584,19 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type + - name: model-version-id + in: query + description: + required: false + type: string + - name: model-name in: query - description: Type of the model, e.g., service, resource, widget, etc. + description: + required: false + type: string + - name: model-version + in: query + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -21166,11 +18673,6 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21237,7 +18739,7 @@ paths: example: __MODEL-INVARIANT-ID__ - name: body in: body - description: model object that needs to be created or updated. + description: model object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model" @@ -21285,6 +18787,17 @@ paths: $ref: "#/getDefinitions/models" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-type + in: query + description: + required: false + type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship: put: tags: @@ -21386,10 +18899,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21474,7 +18983,7 @@ paths: example: __RELATED-LOOKUP-UUID__ - name: body in: body - description: related-lookup object that needs to be created or updated. + description: related-lookup object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/related-lookup" @@ -21542,8 +19051,9 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name + - name: related-lookup-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}: @@ -21579,10 +19089,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21667,7 +19173,7 @@ paths: example: __PROPERTY-CONSTRAINT-UUID__ - name: body in: body - description: property-constraint object that needs to be created or updated. + description: property-constraint object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/property-constraint" @@ -21735,8 +19241,9 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name + - name: property-constraint-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: @@ -21825,10 +19332,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21903,7 +19406,7 @@ paths: example: __NAMED-QUERY-ELEMENT-UUID__ - name: body in: body - description: named-query-element object that needs to be created or updated. + description: named-query-element object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/named-query-element" @@ -21961,8 +19464,9 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name + - name: named-query-element-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: @@ -22036,10 +19540,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22104,7 +19604,7 @@ paths: example: __NAMED-QUERY-UUID__ - name: body in: body - description: named-query object that needs to be created or updated. + description: named-query object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/named-query" @@ -22151,6 +19651,17 @@ paths: $ref: "#/getDefinitions/named-queries" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: query + description: + required: false + type: string + - name: named-query-name + in: query + description: + required: false + type: string /network/logical-links/logical-link/{link-name}/relationship-list/relationship: put: tags: @@ -22225,46 +19736,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: link-id - in: query - description: UUID of the logical-link, SDNC generates this. - required: false - type: string - - name: circuit-id - in: query - description: Circuit id - required: false - type: string - - name: purpose - in: query - description: Reason for this entity, role it is playing - required: false - type: string put: tags: - Network @@ -22331,7 +19802,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: logical-link object that needs to be created or updated. + description: logical-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/logical-link" @@ -22379,6 +19850,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - name: purpose + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship: put: tags: @@ -22609,7 +20126,7 @@ paths: example: __COS__ - name: body in: body - description: class-of-service object that needs to be created or updated. + description: class-of-service object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/class-of-service" @@ -22694,6 +20211,11 @@ paths: required: true type: string example: __SITE-PAIR-ID__ + - name: cos + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship: put: tags: @@ -22894,7 +20416,7 @@ paths: example: __SITE-PAIR-ID__ - name: body in: body - description: site-pair object that needs to be created or updated. + description: site-pair object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/site-pair" @@ -22967,6 +20489,11 @@ paths: required: true type: string example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: put: tags: @@ -23137,7 +20664,7 @@ paths: example: __ROUTING-INSTANCE-ID__ - name: body in: body - description: routing-instance object that needs to be created or updated. + description: routing-instance object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/routing-instance" @@ -23198,6 +20725,11 @@ paths: required: true type: string example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: put: tags: @@ -23338,7 +20870,7 @@ paths: example: __SITE-PAIR-SET-ID__ - name: body in: body - description: site-pair-set object that needs to be created or updated. + description: site-pair-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/site-pair-set" @@ -23386,6 +20918,12 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id + in: query + description: + required: false + type: string /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: put: tags: @@ -23496,16 +21034,6 @@ paths: required: true type: string example: __ROUTE-TARGET-ROLE__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string put: tags: - Network @@ -23596,7 +21124,7 @@ paths: example: __ROUTE-TARGET-ROLE__ - name: body in: body - description: route-target object that needs to be created or updated. + description: route-target object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/route-target" @@ -23663,16 +21191,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: @@ -23747,16 +21265,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string put: tags: - Network @@ -23823,7 +21331,7 @@ paths: example: __VPN-ID__ - name: body in: body - description: vpn-binding object that needs to be created or updated. + description: vpn-binding object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vpn-binding" @@ -23871,6 +21379,22 @@ paths: $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: query + description: + required: false + type: string + - name: vpn-name + in: query + description: + required: false + type: string + - name: vpn-type + in: query + description: + required: false + type: string /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: @@ -24086,16 +21610,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -24184,7 +21698,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -24255,14 +21769,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -24492,58 +22001,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -24656,7 +22113,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -24853,180 +22310,128 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -25112,42 +22517,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -25248,7 +22617,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -25331,29 +22700,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -25481,51 +22841,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -25626,7 +22941,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -25709,29 +23024,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: pci-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -25931,47 +23246,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -26072,7 +23346,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -26245,47 +23519,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -26386,7 +23619,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -26469,31 +23702,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -26582,7 +23790,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -26653,14 +23861,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: interface-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: interface-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: @@ -26692,16 +23910,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -26778,7 +23986,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -26837,9 +24045,14 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ + - name: interface-name + in: query + description: + required: false + type: string - name: prov-status in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -27129,63 +24342,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -27298,7 +24454,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -27495,63 +24651,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -27664,7 +24763,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -27733,190 +24832,149 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - put: - tags: - - Network - summary: create or update an existing vlan - description: | - Create or update an existing vlan. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) - required: true - schema: - $ref: "#/definitions/vlan" - patch: - tags: - - Network - summary: update an existing vlan - description: | - Update an existing vlan - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: body - in: body - description: vlan object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vlan" - delete: - tags: - - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -27983,34 +25041,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -28138,56 +25182,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -28288,7 +25282,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -28371,34 +25365,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -28598,52 +25587,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -28744,7 +25687,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -28917,52 +25860,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -29063,7 +25960,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -29146,36 +26043,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -29264,7 +26131,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -29335,19 +26202,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: interface-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - name: interface-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: @@ -29379,21 +26251,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -29470,7 +26327,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -29529,9 +26386,19 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}: @@ -29557,11 +26424,6 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string put: tags: - Network @@ -29626,7 +26488,7 @@ paths: example: __EQUIPMENT-NAME__ - name: body in: body - description: vpls-pe object that needs to be created or updated. + description: vpls-pe object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vpls-pe" @@ -29673,6 +26535,17 @@ paths: $ref: "#/getDefinitions/vpls-pes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: put: tags: @@ -29813,7 +26686,7 @@ paths: example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: multicast-configuration object that needs to be created or updated. + description: multicast-configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/multicast-configuration" @@ -29861,6 +26734,12 @@ paths: $ref: "#/getDefinitions/multicast-configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: query + description: + required: false + type: string /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: put: tags: @@ -29974,61 +26853,6 @@ paths: type: integer format: int64 example: __CVLAN-TAG__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -30121,7 +26945,7 @@ paths: example: __CVLAN-TAG__ - name: body in: body - description: cvlan-tag-entry object that needs to be created or updated. + description: cvlan-tag-entry object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/cvlan-tag-entry" @@ -30195,61 +27019,12 @@ paths: required: true type: string example: __INTERFACE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id + - name: cvlan-tag in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false - type: string + type: integer + format: int64 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: put: tags: @@ -30342,61 +27117,6 @@ paths: required: true type: string example: __INTERFACE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -30475,7 +27195,7 @@ paths: example: __INTERFACE-ID__ - name: body in: body - description: port-group object that needs to be created or updated. + description: port-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/port-group" @@ -30536,44 +27256,24 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id + - name: interface-id in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + description: required: false type: string - - name: regional-resource-zone + - name: port-group-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: switch-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -30686,46 +27386,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -30816,7 +27476,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: license object that needs to be created or updated. + description: license object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/license" @@ -30883,44 +27543,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id + - name: group-uuid in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: vpe-id + - name: resource-uuid in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -31033,46 +27663,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -31163,7 +27753,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: entitlement object that needs to be created or updated. + description: entitlement object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/entitlement" @@ -31230,44 +27820,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id + - name: group-uuid in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: vpe-id + - name: resource-uuid in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/relationship-list/relationship: @@ -31344,46 +27904,6 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -31450,7 +27970,7 @@ paths: example: __VNF-ID__ - name: body in: body - description: vce object that needs to be created or updated. + description: vce object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vce" @@ -31498,6 +28018,52 @@ paths: $ref: "#/getDefinitions/vces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: query + description: + required: false + type: string + - name: vnf-name + in: query + description: + required: false + type: string + - name: vnf-name2 + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: regional-resource-zone + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: vpe-id + in: query + description: + required: false + type: string /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: put: tags: @@ -31640,65 +28206,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -31777,7 +28284,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -31906,65 +28413,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -32043,7 +28491,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -32104,49 +28552,6 @@ paths: required: true type: string example: __VNFC-NAME__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -32213,7 +28618,7 @@ paths: example: __VNFC-NAME__ - name: body in: body - description: vnfc object that needs to be created or updated. + description: vnfc object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vnfc" @@ -32261,6 +28666,57 @@ paths: $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: query + description: + required: false + type: string + - name: nfc-naming-code + in: query + description: + required: false + type: string + - name: nfc-function + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: group-notation + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship: put: tags: @@ -32371,56 +28827,6 @@ paths: required: true type: string example: __HOST-ROUTE-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -32511,7 +28917,7 @@ paths: example: __HOST-ROUTE-ID__ - name: body in: body - description: host-route object that needs to be created or updated. + description: host-route object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/host-route" @@ -32584,54 +28990,9 @@ paths: required: true type: string example: __SUBNET-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name + - name: host-route-id in: query - description: Name associated with the subnet. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: @@ -32726,56 +29087,6 @@ paths: required: true type: string example: __SUBNET-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -32854,7 +29165,7 @@ paths: example: __SUBNET-ID__ - name: body in: body - description: subnet object that needs to be created or updated. + description: subnet object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/subnet" @@ -32915,49 +29226,14 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: subnet-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: subnet-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: @@ -33055,51 +29331,6 @@ paths: type: integer format: int64 example: __VLAN-ID-INNER__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -33180,7 +29411,7 @@ paths: example: __VLAN-ID-INNER__ - name: body in: body - description: ctag-assignment object that needs to be created or updated. + description: ctag-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ctag-assignment" @@ -33242,51 +29473,12 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: vlan-id-inner in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false - type: string + type: integer + format: int64 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: put: tags: @@ -33379,51 +29571,6 @@ paths: required: true type: string example: __SEGMENTATION-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -33502,7 +29649,7 @@ paths: example: __SEGMENTATION-ID__ - name: body in: body - description: segmentation-assignment object that needs to be created or updated. + description: segmentation-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/segmentation-assignment" @@ -33563,49 +29710,9 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: segmentation-id in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: @@ -33682,51 +29789,6 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -33793,7 +29855,7 @@ paths: example: __NETWORK-ID__ - name: body in: body - description: l3-network object that needs to be created or updated. + description: l3-network object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-network" @@ -33841,6 +29903,57 @@ paths: $ref: "#/getDefinitions/l3-networks" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + - name: network-role + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: contrail-network-fqdn + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: @@ -33915,11 +30028,6 @@ paths: required: true type: string example: __NETWORK-POLICY-ID__ - - name: network-policy-fqdn - in: query - description: Contrail FQDN for the policy - required: false - type: string put: tags: - Network @@ -33986,7 +30094,7 @@ paths: example: __NETWORK-POLICY-ID__ - name: body in: body - description: network-policy object that needs to be created or updated. + description: network-policy object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/network-policy" @@ -34034,6 +30142,17 @@ paths: $ref: "#/getDefinitions/network-policies" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: query + description: + required: false + type: string + - name: network-policy-fqdn + in: query + description: + required: false + type: string /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: put: tags: @@ -34259,231 +30378,106 @@ paths: description: successful operation schema: $ref: "#/getDefinitions/l3-interface-ipv4-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: | - Create or update an existing l3-interface-ipv4-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv4-address-list - description: | - Update an existing l3-interface-ipv4-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -34513,7 +30507,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -34690,131 +30684,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -34917,7 +30786,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -35002,115 +30871,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -35201,7 +30961,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -35274,102 +31034,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -35482,124 +31160,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -35690,7 +31250,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -35763,102 +31323,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -36033,120 +31520,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -36237,7 +31610,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -36390,120 +31763,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -36594,7 +31853,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -36667,104 +31926,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -36843,7 +32004,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -36904,87 +32065,24 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type + - name: interface-name in: query - description: Generic description of the type of NF + description: required: false type: string - - name: nf-function + - name: interface-id in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: macaddr in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: network-name in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -37281,141 +32379,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -37530,7 +32493,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -37707,165 +32670,30 @@ paths: required: true type: string example: __VNF-ID__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network @@ -37980,7 +32808,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -38077,125 +32905,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -38298,7 +33007,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -38383,112 +33092,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -38619,134 +33236,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -38849,7 +33338,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -38934,112 +33423,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -39228,146 +33634,22 @@ paths: example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + description: Name that identifies the link aggregate interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network @@ -39470,7 +33752,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -39647,130 +33929,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39873,7 +34031,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -39958,114 +34116,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -40156,7 +34206,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -40229,97 +34279,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: interface-name in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: interface-id in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - - name: interface-id + - name: macaddr in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: @@ -40352,99 +34329,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -40523,7 +34407,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -40584,87 +34468,19 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function + - name: interface-name in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: interface-id in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: interface-role in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: @@ -40759,124 +34575,6 @@ paths: required: true type: string example: __VF-MODULE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: vf-module-name - in: query - description: Name of vf-module - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - required: false - type: string put: tags: - Network @@ -40955,7 +34653,7 @@ paths: example: __VF-MODULE-ID__ - name: body in: body - description: vf-module object that needs to be created or updated. + description: vf-module object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vf-module" @@ -41016,87 +34714,44 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: vf-module-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-module-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: contrail-service-instance-fqdn in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -41209,89 +34864,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string put: tags: - Network @@ -41382,7 +34954,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: license object that needs to be created or updated. + description: license object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/license" @@ -41449,87 +35021,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: group-uuid in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: resource-uuid in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -41642,89 +35141,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string put: tags: - Network @@ -41815,7 +35231,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: entitlement object that needs to be created or updated. + description: entitlement object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/entitlement" @@ -41882,87 +35298,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: group-uuid in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: resource-uuid in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}: @@ -41989,203 +35332,211 @@ paths: required: true type: string example: __VNF-ID__ + put: + tags: + - Network + summary: create or update an existing generic-vnf + description: | + Create or update an existing generic-vnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) + required: true + schema: + $ref: "#/definitions/generic-vnf" + patch: + tags: + - Network + summary: update an existing generic-vnf + description: | + Update an existing generic-vnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/generic-vnf" + delete: + tags: + - Network + summary: delete an existing generic-vnf + description: delete an existing generic-vnf + operationId: deleteNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs: + get: + tags: + - Network + summary: returns generic-vnfs + description: returns generic-vnfs + operationId: getNetworkGenericVnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: query + description: + required: false + type: string - name: vnf-name in: query - description: Name of VNF. + description: required: false type: string - name: vnf-name2 in: query - description: Alternate name of VNF. + description: required: false type: string - name: vnf-type in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + description: required: false type: string - name: service-id in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + description: required: false type: string - name: regional-resource-zone in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - name: prov-status in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - name: in-maint in: query + description: required: false type: boolean - name: is-closed-loop-disabled in: query + description: required: false type: boolean - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - name: nf-type in: query - description: Generic description of the type of NF + description: required: false type: string - name: nf-function in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - name: nf-role in: query - description: role in the network that this model will be providing + description: required: false type: string - name: nf-naming-code in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - put: - tags: - - Network - summary: create or update an existing generic-vnf - description: | - Create or update an existing generic-vnf. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: body - in: body - description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) - required: true - schema: - $ref: "#/definitions/generic-vnf" - patch: - tags: - - Network - summary: update an existing generic-vnf - description: | - Update an existing generic-vnf - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkGenericVnfsGenericVnf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: body - in: body - description: generic-vnf object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/generic-vnf" - delete: - tags: - - Network - summary: delete an existing generic-vnf - description: delete an existing generic-vnf - operationId: deleteNetworkGenericVnfsGenericVnf - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/generic-vnfs: - get: - tags: - - Network - summary: returns generic-vnfs - description: returns generic-vnfs - operationId: getNetworkGenericVnfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/generic-vnfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: @@ -42326,7 +35677,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: lag-link object that needs to be created or updated. + description: lag-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-link" @@ -42374,6 +35725,12 @@ paths: $ref: "#/getDefinitions/lag-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: put: tags: @@ -42626,73 +35983,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -42795,7 +36085,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -42972,73 +36262,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -43141,7 +36364,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -43179,104 +36402,53 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-id + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: ID of interface - required: false + description: resource-version for concurrency + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network @@ -43367,7 +36539,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -43440,44 +36612,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -43590,66 +36738,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -43740,7 +36828,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -43813,44 +36901,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status + - name: pci-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-vlan-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -44025,62 +37098,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -44171,7 +37188,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -44324,62 +37341,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -44470,7 +37431,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -44543,46 +37504,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -44661,7 +37582,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -44722,29 +37643,24 @@ paths: required: true type: string example: __VNF-ID2__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 + - name: interface-name in: query - description: Alternate name of VNF. + description: required: false type: string - - name: vnf-type + - name: interface-id in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + description: required: false type: string - - name: prov-status + - name: macaddr in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: network-name in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string /network/newvces/newvce/{vnf-id2}: @@ -44771,31 +37687,6 @@ paths: required: true type: string example: __VNF-ID2__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -44862,7 +37753,7 @@ paths: example: __VNF-ID2__ - name: body in: body - description: newvce object that needs to be created or updated. + description: newvce object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/newvce" @@ -44910,6 +37801,37 @@ paths: $ref: "#/getDefinitions/newvces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: query + description: + required: false + type: string + - name: vnf-name + in: query + description: + required: false + type: string + - name: vnf-name2 + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: put: tags: @@ -45132,16 +38054,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -45232,7 +38144,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -45305,14 +38217,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -45547,58 +38454,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -45713,7 +38568,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -45914,58 +38769,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -46080,7 +38883,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -46177,42 +38980,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -46315,7 +39082,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -46400,29 +39167,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -46553,51 +39311,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -46700,7 +39413,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -46785,29 +39498,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: pci-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -47012,47 +39725,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -47155,7 +39827,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -47332,47 +40004,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -47475,7 +40106,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -47560,31 +40191,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -47675,7 +40281,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -47748,14 +40354,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: prov-status + - name: interface-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -47788,16 +40404,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -47876,7 +40482,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -47937,9 +40543,14 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status + - name: interface-name + in: query + description: + required: false + type: string + - name: prov-status in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -48236,63 +40847,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -48407,7 +40961,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -48608,63 +41162,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -48779,7 +41276,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -48823,100 +41320,59 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/vlan" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-role + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + description: resource-version for concurrency + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network @@ -49019,7 +41475,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -49104,34 +41560,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -49262,56 +41704,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -49414,7 +41806,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -49499,34 +41891,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -49731,52 +42118,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -49879,7 +42220,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -50056,52 +42397,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -50204,7 +42499,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -50289,36 +42584,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -50409,7 +42674,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -50482,19 +42747,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - name: interface-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: macaddr in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: @@ -50527,21 +42797,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -50620,7 +42875,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -50681,9 +42936,19 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -50710,11 +42975,6 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string put: tags: - Network @@ -50781,7 +43041,7 @@ paths: example: __PNF-NAME__ - name: body in: body - description: pnf object that needs to be created or updated. + description: pnf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/pnf" @@ -50829,6 +43089,17 @@ paths: $ref: "#/getDefinitions/pnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: query + description: + required: false + type: string + - name: inv-status + in: query + description: + required: false + type: string /network/physical-links/physical-link/{link-name}/relationship-list/relationship: put: tags: @@ -50903,11 +43174,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -50974,7 +43240,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: physical-link object that needs to be created or updated. + description: physical-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/physical-link" @@ -51022,6 +43288,17 @@ paths: $ref: "#/getDefinitions/physical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: put: tags: @@ -51242,7 +43519,7 @@ paths: example: __VIG-ADDRESS-TYPE__ - name: body in: body - description: vig-server object that needs to be created or updated. + description: vig-server object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vig-server" @@ -51303,6 +43580,11 @@ paths: required: true type: string example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: query + description: + required: false + type: string /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: get: tags: @@ -51393,7 +43675,7 @@ paths: example: __IPSEC-CONFIGURATION-ID__ - name: body in: body - description: ipsec-configuration object that needs to be created or updated. + description: ipsec-configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ipsec-configuration" @@ -51441,6 +43723,12 @@ paths: $ref: "#/getDefinitions/ipsec-configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: query + description: + required: false + type: string /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: put: tags: @@ -51515,11 +43803,6 @@ paths: required: true type: string example: __ROUTE-TABLE-REFERENCE-ID__ - - name: route-table-reference-fqdn - in: query - description: FQDN entry in the route table. - required: false - type: string put: tags: - Network @@ -51586,7 +43869,7 @@ paths: example: __ROUTE-TABLE-REFERENCE-ID__ - name: body in: body - description: route-table-reference object that needs to be created or updated. + description: route-table-reference object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/route-table-reference" @@ -51634,6 +43917,17 @@ paths: $ref: "#/getDefinitions/route-table-references" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: query + description: + required: false + type: string + - name: route-table-reference-fqdn + in: query + description: + required: false + type: string /network/instance-groups/instance-group/{id}/relationship-list/relationship: put: tags: @@ -51708,21 +44002,6 @@ paths: required: true type: string example: __ID__ - - name: description - in: query - description: Descriptive text to help identify the usage of this instance-group - required: false - type: string - - name: type - in: query - description: Only valid value today is lower case ha for high availability - required: false - type: string - - name: sub-type - in: query - description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] - required: false - type: string put: tags: - Network @@ -51789,7 +44068,7 @@ paths: example: __ID__ - name: body in: body - description: instance-group object that needs to be created or updated. + description: instance-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/instance-group" @@ -51837,6 +44116,27 @@ paths: $ref: "#/getDefinitions/instance-groups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: query + description: + required: false + type: string + - name: description + in: query + description: + required: false + type: string + - name: type + in: query + description: + required: false + type: string + - name: sub-type + in: query + description: + required: false + type: string /network/zones/zone/{zone-id}/relationship-list/relationship: put: tags: @@ -51911,16 +44211,6 @@ paths: required: true type: string example: __ZONE-ID__ - - name: design-type - in: query - description: Design of zone [Medium/Large?] - required: false - type: string - - name: zone-context - in: query - description: Context of zone [production/test] - required: false - type: string put: tags: - Network @@ -51987,7 +44277,7 @@ paths: example: __ZONE-ID__ - name: body in: body - description: zone object that needs to be created or updated. + description: zone object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/zone" @@ -52035,6 +44325,22 @@ paths: $ref: "#/getDefinitions/zones" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: query + description: + required: false + type: string + - name: design-type + in: query + description: + required: false + type: string + - name: zone-context + in: query + description: + required: false + type: string /network/configurations/configuration/{configuration-id}/relationship-list/relationship: put: tags: @@ -52114,16 +44420,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -52200,7 +44496,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -52260,14 +44556,9 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id + - name: metaname in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string /network/configurations/configuration/{configuration-id}: @@ -52294,16 +44585,6 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -52370,7 +44651,7 @@ paths: example: __CONFIGURATION-ID__ - name: body in: body - description: configuration object that needs to be created or updated. + description: configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/configuration" @@ -52418,13 +44699,23 @@ paths: $ref: "#/getDefinitions/configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -52453,20 +44744,23 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -52523,15 +44817,18 @@ definitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -52599,7 +44896,9 @@ definitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -52655,26 +44954,28 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -52706,6 +45007,7 @@ definitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -52777,20 +45079,22 @@ definitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -52860,13 +45164,15 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -52932,10 +45238,11 @@ definitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -52980,10 +45287,12 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -53014,8 +45323,10 @@ definitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -53040,10 +45351,12 @@ definitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -53078,8 +45391,9 @@ definitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -53138,8 +45452,9 @@ definitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -53213,9 +45528,11 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -53246,8 +45563,10 @@ definitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -53277,8 +45596,9 @@ definitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -53304,10 +45624,12 @@ definitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -53390,9 +45712,10 @@ definitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -53424,8 +45747,9 @@ definitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -53457,7 +45781,9 @@ definitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -53547,9 +45873,11 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -53608,12 +45936,14 @@ definitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -53635,7 +45965,9 @@ definitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -53677,11 +46009,13 @@ definitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -53716,43 +46050,40 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -53856,8 +46187,10 @@ definitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -53968,9 +46301,10 @@ definitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -54006,7 +46340,9 @@ definitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -54049,10 +46385,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -54084,7 +46421,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -54105,11 +46444,13 @@ definitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -54182,22 +46523,20 @@ definitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -54261,13 +46600,9 @@ definitions: network: type: object $ref: "#/definitions/network" - aai-internal: - type: object - $ref: "#/definitions/aai-internal" nodes: - type: array - items: - $ref: "#/definitions/aai-internal" + type: object + $ref: "#/definitions/nodes" inventory-item: properties: inventory-item-type: @@ -54312,9 +46647,10 @@ definitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -54408,22 +46744,24 @@ definitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -54459,16 +46797,19 @@ definitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. @@ -54508,12 +46849,14 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -54552,12 +46895,14 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -54596,23 +46941,24 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -54641,6 +46987,7 @@ definitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -54686,10 +47033,13 @@ definitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. @@ -54723,16 +47073,18 @@ definitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -54763,6 +47115,7 @@ definitions: description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: @@ -54783,8 +47136,10 @@ definitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -54810,8 +47165,10 @@ definitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -54841,7 +47198,8 @@ definitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -54867,21 +47225,23 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -54892,6 +47252,7 @@ definitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -54970,11 +47331,13 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -54990,13 +47353,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -55039,9 +47404,11 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -55067,14 +47434,16 @@ definitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -55117,12 +47486,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -55172,7 +47544,8 @@ definitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -55212,10 +47585,11 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -55245,13 +47619,15 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -55376,8 +47752,9 @@ definitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -55401,7 +47778,8 @@ definitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -55430,8 +47808,9 @@ definitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -55495,6 +47874,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -55550,9 +47935,10 @@ definitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -55594,8 +47980,9 @@ definitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -55690,7 +48077,8 @@ definitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -55712,16 +48100,18 @@ definitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -55758,6 +48148,7 @@ definitions: description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status @@ -55785,7 +48176,9 @@ definitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -55843,7 +48236,8 @@ definitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -55869,16 +48263,17 @@ definitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -55915,6 +48310,7 @@ definitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -55972,9 +48368,11 @@ definitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -56030,7 +48428,8 @@ definitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -56064,7 +48463,9 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -56091,19 +48492,20 @@ definitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -56173,6 +48575,7 @@ definitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -56225,7 +48628,9 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -56333,7 +48738,8 @@ definitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -56363,7 +48769,9 @@ definitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -56392,9 +48800,11 @@ definitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -56475,7 +48885,9 @@ definitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -56535,9 +48947,11 @@ definitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -56583,35 +48997,32 @@ definitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -56709,10 +49120,12 @@ definitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -56752,9 +49165,11 @@ definitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -56791,9 +49206,10 @@ definitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -56831,8 +49247,9 @@ definitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -56885,8 +49302,10 @@ definitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -56912,8 +49331,10 @@ definitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -56980,14 +49401,17 @@ definitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -57018,6 +49442,7 @@ definitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -57061,13 +49486,15 @@ definitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -57104,7 +49531,9 @@ definitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id - bandwidth-up-wan1 @@ -57170,14 +49599,15 @@ definitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -57268,12 +49698,15 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -57292,6 +49725,7 @@ definitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -57339,7 +49773,9 @@ definitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -57369,10 +49805,11 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -57411,10 +49848,11 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -57453,9 +49891,10 @@ definitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -57485,15 +49924,17 @@ definitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -57533,11 +49974,13 @@ definitions: description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. relationship-list: type: array items: @@ -57569,8 +50012,10 @@ definitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -57609,15 +50054,17 @@ definitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -57645,8 +50092,10 @@ definitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -57683,7 +50132,9 @@ definitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -57705,11 +50156,12 @@ definitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -57763,11 +50215,12 @@ definitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -57813,12 +50266,14 @@ definitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -57866,19 +50321,20 @@ definitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -57903,8 +50359,10 @@ definitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -57932,11 +50390,12 @@ definitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -57974,12 +50433,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -58008,20 +50461,23 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -58055,15 +50511,18 @@ patchDefinitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -58124,7 +50583,9 @@ patchDefinitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -58173,26 +50634,28 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -58224,6 +50687,7 @@ patchDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -58240,20 +50704,22 @@ patchDefinitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -58287,13 +50753,15 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -58348,10 +50816,11 @@ patchDefinitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -58370,10 +50839,12 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -58394,8 +50865,10 @@ patchDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -58413,10 +50886,12 @@ patchDefinitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -58444,8 +50919,9 @@ patchDefinitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -58486,8 +50962,9 @@ patchDefinitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -58554,9 +51031,11 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -58577,8 +51056,10 @@ patchDefinitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -58601,8 +51082,9 @@ patchDefinitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -58619,10 +51101,12 @@ patchDefinitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -58698,9 +51182,10 @@ patchDefinitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -58723,8 +51208,9 @@ patchDefinitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -58747,7 +51233,9 @@ patchDefinitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -58830,9 +51318,11 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -58884,12 +51374,14 @@ patchDefinitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -58904,7 +51396,9 @@ patchDefinitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -58939,11 +51433,13 @@ patchDefinitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -58964,43 +51460,40 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -59104,8 +51597,10 @@ patchDefinitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node generic-vnfs: description: | Collection of VNFs @@ -59118,9 +51613,10 @@ patchDefinitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -59149,7 +51645,9 @@ patchDefinitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -59185,10 +51683,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -59209,7 +51708,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -59223,11 +51724,13 @@ patchDefinitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -59289,22 +51792,20 @@ patchDefinitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -59361,13 +51862,9 @@ patchDefinitions: network: type: object $ref: "#/patchDefinitions/network" - aai-internal: - type: object - $ref: "#/patchDefinitions/aai-internal" nodes: - type: array - items: - $ref: "#/patchDefinitions/aai-internal" + type: object + $ref: "#/patchDefinitions/nodes" inventory-item: properties: inventory-item-type: @@ -59412,9 +51909,10 @@ patchDefinitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -59497,22 +51995,24 @@ patchDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -59548,6 +52048,7 @@ patchDefinitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. l-interfaces: description: | Collection of logical interfaces. @@ -59560,12 +52061,14 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -59591,12 +52094,14 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -59622,23 +52127,24 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -59667,6 +52173,7 @@ patchDefinitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -59684,16 +52191,18 @@ patchDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -59716,8 +52225,10 @@ patchDefinitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -59736,8 +52247,10 @@ patchDefinitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -59760,7 +52273,8 @@ patchDefinitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -59779,21 +52293,23 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -59804,6 +52320,7 @@ patchDefinitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -59839,11 +52356,13 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -59856,13 +52375,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -59894,9 +52415,11 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -59919,14 +52442,16 @@ patchDefinitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -59952,12 +52477,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -59992,7 +52520,8 @@ patchDefinitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -60025,10 +52554,11 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -60048,13 +52578,15 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -60157,8 +52689,9 @@ patchDefinitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -60175,7 +52708,8 @@ patchDefinitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -60197,8 +52731,9 @@ patchDefinitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -60239,6 +52774,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -60294,9 +52835,10 @@ patchDefinitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -60331,8 +52873,9 @@ patchDefinitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -60411,7 +52954,8 @@ patchDefinitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -60426,16 +52970,18 @@ patchDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -60479,7 +53025,9 @@ patchDefinitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -60530,7 +53078,8 @@ patchDefinitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -60549,16 +53098,17 @@ patchDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -60595,6 +53145,7 @@ patchDefinitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -60631,9 +53182,11 @@ patchDefinitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -60660,7 +53213,8 @@ patchDefinitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -60687,7 +53241,9 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -60712,19 +53268,20 @@ patchDefinitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -60794,6 +53351,7 @@ patchDefinitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. pservers: description: | Collection of compute hosts. @@ -60816,7 +53374,9 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -60916,7 +53476,8 @@ patchDefinitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -60939,7 +53500,9 @@ patchDefinitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -60961,9 +53524,11 @@ patchDefinitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -61033,7 +53598,9 @@ patchDefinitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -61076,9 +53643,11 @@ patchDefinitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -61117,35 +53686,32 @@ patchDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -61222,10 +53788,12 @@ patchDefinitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -61254,9 +53822,11 @@ patchDefinitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -61282,9 +53852,10 @@ patchDefinitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -61311,8 +53882,9 @@ patchDefinitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -61358,8 +53930,10 @@ patchDefinitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -61378,8 +53952,10 @@ patchDefinitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -61436,14 +54012,17 @@ patchDefinitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -61474,6 +54053,7 @@ patchDefinitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -61502,13 +54082,15 @@ patchDefinitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -61534,7 +54116,9 @@ patchDefinitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id - bandwidth-up-wan1 @@ -61593,14 +54177,15 @@ patchDefinitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -61666,12 +54251,15 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -61690,6 +54278,7 @@ patchDefinitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module vf-modules: description: | Collection of vf-modules, a deployment unit of VNFCs @@ -61702,7 +54291,9 @@ patchDefinitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -61725,10 +54316,11 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -61754,10 +54346,11 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -61783,9 +54376,10 @@ patchDefinitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -61808,15 +54402,17 @@ patchDefinitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -61852,8 +54448,10 @@ patchDefinitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -61885,15 +54483,17 @@ patchDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -61921,8 +54521,10 @@ patchDefinitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -61944,7 +54546,9 @@ patchDefinitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -61959,11 +54563,12 @@ patchDefinitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -62010,11 +54615,12 @@ patchDefinitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -62045,12 +54651,14 @@ patchDefinitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -62086,19 +54694,20 @@ patchDefinitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -62123,8 +54732,10 @@ patchDefinitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node vservers: description: | Collection of virtual Servers, aka virtual machines or VMs. @@ -62137,11 +54748,12 @@ patchDefinitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -62172,12 +54784,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -62206,20 +54812,23 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -62276,15 +54885,18 @@ getDefinitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -62352,7 +54964,9 @@ getDefinitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -62408,26 +55022,28 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -62459,6 +55075,7 @@ getDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -62530,20 +55147,22 @@ getDefinitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -62613,13 +55232,15 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - CONFIGURATION is DELETED when these are DELETED METADATUM - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -62685,10 +55306,11 @@ getDefinitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -62733,10 +55355,12 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -62767,8 +55391,10 @@ getDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -62793,10 +55419,12 @@ getDefinitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -62831,8 +55459,9 @@ getDefinitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -62891,8 +55520,9 @@ getDefinitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -62966,9 +55596,11 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -62999,8 +55631,10 @@ getDefinitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -63030,8 +55664,9 @@ getDefinitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -63057,10 +55692,12 @@ getDefinitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -63143,9 +55780,10 @@ getDefinitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -63177,8 +55815,9 @@ getDefinitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -63210,7 +55849,9 @@ getDefinitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -63300,9 +55941,11 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - flavor-id - flavor-name @@ -63361,12 +56004,14 @@ getDefinitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -63388,7 +56033,9 @@ getDefinitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -63430,11 +56077,13 @@ getDefinitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -63469,43 +56118,40 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -63609,8 +56255,10 @@ getDefinitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -63721,9 +56369,10 @@ getDefinitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -63759,7 +56408,9 @@ getDefinitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -63802,10 +56453,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -63837,7 +56489,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -63858,11 +56512,13 @@ getDefinitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -63935,22 +56591,20 @@ getDefinitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -64014,13 +56668,9 @@ getDefinitions: network: type: object $ref: "#/getDefinitions/network" - aai-internal: - type: object - $ref: "#/getDefinitions/aai-internal" nodes: - type: array - items: - $ref: "#/getDefinitions/aai-internal" + type: object + $ref: "#/getDefinitions/nodes" inventory-item: properties: inventory-item-type: @@ -64065,9 +56715,10 @@ getDefinitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -64161,22 +56812,24 @@ getDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -64212,16 +56865,19 @@ getDefinitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. @@ -64261,12 +56917,14 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -64305,12 +56963,14 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -64349,23 +57009,24 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -64394,6 +57055,7 @@ getDefinitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -64439,10 +57101,13 @@ getDefinitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. @@ -64476,16 +57141,18 @@ getDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -64516,6 +57183,7 @@ getDefinitions: description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: @@ -64536,8 +57204,10 @@ getDefinitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -64563,8 +57233,10 @@ getDefinitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -64594,7 +57266,8 @@ getDefinitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -64620,21 +57293,23 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -64645,6 +57320,7 @@ getDefinitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -64723,11 +57399,13 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -64743,13 +57421,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -64792,9 +57472,11 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -64820,14 +57502,16 @@ getDefinitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -64870,12 +57554,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -64925,7 +57612,8 @@ getDefinitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -64965,10 +57653,11 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -64998,13 +57687,15 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -65129,8 +57820,9 @@ getDefinitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -65154,7 +57846,8 @@ getDefinitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -65183,8 +57876,9 @@ getDefinitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -65248,6 +57942,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -65303,9 +58003,10 @@ getDefinitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -65347,8 +58048,9 @@ getDefinitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -65443,7 +58145,8 @@ getDefinitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -65465,16 +58168,18 @@ getDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -65511,6 +58216,7 @@ getDefinitions: description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status @@ -65538,7 +58244,9 @@ getDefinitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -65596,7 +58304,8 @@ getDefinitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -65622,16 +58331,17 @@ getDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -65668,6 +58378,7 @@ getDefinitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -65725,9 +58436,11 @@ getDefinitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -65783,7 +58496,8 @@ getDefinitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -65817,7 +58531,9 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -65844,19 +58560,20 @@ getDefinitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -65926,6 +58643,7 @@ getDefinitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -65978,7 +58696,9 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -66090,7 +58810,8 @@ getDefinitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -66120,7 +58841,9 @@ getDefinitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -66149,9 +58872,11 @@ getDefinitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -66232,7 +58957,9 @@ getDefinitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -66292,9 +59019,11 @@ getDefinitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -66340,35 +59069,32 @@ getDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -66466,10 +59192,12 @@ getDefinitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -66509,9 +59237,11 @@ getDefinitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -66548,9 +59278,10 @@ getDefinitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -66588,8 +59319,9 @@ getDefinitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -66642,8 +59374,10 @@ getDefinitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -66669,8 +59403,10 @@ getDefinitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -66737,14 +59473,17 @@ getDefinitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -66775,6 +59514,7 @@ getDefinitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -66818,13 +59558,15 @@ getDefinitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -66861,7 +59603,9 @@ getDefinitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id - bandwidth-up-wan1 @@ -66927,14 +59671,15 @@ getDefinitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -67025,12 +59770,15 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -67049,6 +59797,7 @@ getDefinitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -67096,7 +59845,9 @@ getDefinitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -67126,10 +59877,11 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -67168,10 +59920,11 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -67210,9 +59963,10 @@ getDefinitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -67242,15 +59996,17 @@ getDefinitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -67290,11 +60046,13 @@ getDefinitions: description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. relationship-list: type: array items: @@ -67326,8 +60084,10 @@ getDefinitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -67366,15 +60126,17 @@ getDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -67402,8 +60164,10 @@ getDefinitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -67440,7 +60204,9 @@ getDefinitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -67462,11 +60228,12 @@ getDefinitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -67520,11 +60287,12 @@ getDefinitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -67570,12 +60338,14 @@ getDefinitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -67623,19 +60393,20 @@ getDefinitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -67660,8 +60431,10 @@ getDefinitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -67689,11 +60462,12 @@ getDefinitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name