X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v12.yaml;h=b4aac6c7f5d41517071aafe2cdf7eea126144c79;hb=f1a8fb1bc04f5d685f2b31d35db605f6fa054f60;hp=130578d42a3c7d632fe894b9b5ca7e22e6cf5f32;hpb=b1264ad4012f67664d71982a0eaad7e9bcce34f4;p=aai%2Faai-common.git diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml index 130578d4..b4aac6c7 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml @@ -141,21 +141,6 @@ paths: required: true type: string example: __AVAILABILITY-ZONE-NAME__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string put: tags: - CloudInfrastructure @@ -246,7 +231,7 @@ paths: example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: ctag-pool object that needs to be created or updated. + description: ctag-pool object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ctag-pool" @@ -313,19 +298,9 @@ paths: required: true type: string example: __PHYSICAL-LOCATION-ID__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url + - name: availability-zone-name in: query - description: URL of the keystone identity service + description: required: false type: string /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: @@ -402,21 +377,6 @@ paths: required: true type: string example: __PHYSICAL-LOCATION-ID__ - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string put: tags: - CloudInfrastructure @@ -483,7 +443,7 @@ paths: example: __PHYSICAL-LOCATION-ID__ - name: body in: body - description: complex object that needs to be created or updated. + description: complex object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/complex" @@ -531,6 +491,27 @@ paths: $ref: "#/getDefinitions/complexes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: query + description: + required: false + type: string + - name: data-center-code + in: query + description: + required: false + type: string + - name: complex-name + in: query + description: + required: false + type: string + - name: identity-url + in: query + description: + required: false + type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: put: tags: @@ -641,31 +622,6 @@ paths: required: true type: string example: __VOLUME-GROUP-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: volume-group-name - in: query - description: Name of the volume group. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this volume-group - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string put: tags: - CloudInfrastructure @@ -756,7 +712,7 @@ paths: example: __VOLUME-GROUP-ID__ - name: body in: body - description: volume-group object that needs to be created or updated. + description: volume-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/volume-group" @@ -829,214 +785,32 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: - get: - tags: - - CloudInfrastructure - summary: returns volume - description: returns volume - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/volume" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - example: __TENANT-ID__ - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - required: true - type: string - example: __VSERVER-ID__ - - name: volume-id - in: path - description: Unique ID of block storage volume relative to the vserver. - required: true - type: string - example: __VOLUME-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context + - name: volume-group-id in: query - description: This field will store the tenant context. + description: required: false type: string - - name: vserver-name + - name: volume-group-name in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: heat-stack-id in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: vnf-type in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing volume - description: | - Create or update an existing volume. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml @@ -1079,27 +853,16 @@ paths: example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: - $ref: "#/definitions/volume" - patch: + $ref: "#/definitions/relationship" + delete: tags: - CloudInfrastructure - summary: update an existing volume - description: | - Update an existing volume - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml @@ -1140,25 +903,21 @@ paths: required: true type: string example: __VOLUME-ID__ - - name: body - in: body - description: volume object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/volume" - delete: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: + get: tags: - CloudInfrastructure - summary: delete an existing volume - description: delete an existing volume - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume - consumes: - - application/json - - application/xml + summary: returns volume + description: returns volume + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volume" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1192,26 +951,22 @@ paths: required: true type: string example: __VOLUME-ID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: - get: + put: tags: - CloudInfrastructure - summary: returns volumes - description: returns volumes - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes + summary: create or update an existing volume + description: | + Create or update an existing volume. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1239,55 +994,35 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: - put: + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/volume" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + summary: update an existing volume + description: | + Update an existing volume + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml @@ -1322,18 +1057,24 @@ paths: required: true type: string example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) + description: volume object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/volume" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + summary: delete an existing volume + description: delete an existing volume + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml @@ -1368,19 +1109,32 @@ paths: required: true type: string example: __VSERVER-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true + type: string + example: __VOLUME-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: + get: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns volumes + description: returns volumes + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1408,21 +1162,54 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: interface-name + - name: volume-id + in: query + description: + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner in: path - description: Name given to the interface + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - example: __INTERFACE-NAME__ - - name: vlan-interface + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: String that identifies the interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - example: __VLAN-INTERFACE__ + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1431,7 +1218,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml @@ -1466,24 +1253,12 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1530,15 +1305,9 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1547,7 +1316,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -1594,27 +1363,19 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV4-ADDRESS__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: - get: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + put: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1660,91 +1421,130 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vserver-name - in: query - description: Name of vserver - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure @@ -1883,7 +1683,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -2132,91 +1932,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -2355,7 +2070,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -2476,75 +2191,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -2671,7 +2317,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -2780,62 +2426,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -3002,84 +2606,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -3206,7 +2732,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -3315,62 +2841,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name + - name: pci-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: vf-vlan-filter in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: vf-mac-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -3635,80 +3128,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -3835,7 +3254,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -4060,80 +3479,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -4260,7 +3605,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -4369,64 +3714,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -4541,7 +3828,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -4638,49 +3925,26 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context + - name: interface-name in: query - description: This field will store the tenant context. + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -4723,49 +3987,6 @@ paths: required: true type: string example: __VSERVER-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean put: tags: - CloudInfrastructure @@ -4868,7 +4089,7 @@ paths: example: __VSERVER-ID__ - name: body in: body - description: vserver object that needs to be created or updated. + description: vserver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vserver" @@ -4953,26 +4174,36 @@ paths: required: true type: string example: __TENANT-ID__ - - name: cloud-type + - name: vserver-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vserver-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - - name: tenant-name + - name: vserver-name2 in: query - description: Readable name of tenant + description: required: false type: string - - name: tenant-context + - name: prov-status in: query - description: This field will store the tenant context. + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -5083,26 +4314,6 @@ paths: required: true type: string example: __TENANT-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string put: tags: - CloudInfrastructure @@ -5193,7 +4404,7 @@ paths: example: __TENANT-ID__ - name: body in: body - description: tenant object that needs to be created or updated. + description: tenant object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/tenant" @@ -5266,14 +4477,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: tenant-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: tenant-name + in: query + description: + required: false + type: string + - name: tenant-context in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: @@ -5508,31 +4724,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: flavor-name - in: query - description: Cloud region Flavor name - required: false - type: string - - name: hpa-feature - in: query - description: Name of the HPACapability - required: false - type: string - - name: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5647,7 +4838,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -5744,31 +4935,6 @@ paths: required: true type: string example: __HPA-CAPABILITY-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: flavor-name - in: query - description: Cloud region Flavor name - required: false - type: string - - name: hpa-feature - in: query - description: Name of the HPACapability - required: false - type: string - - name: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -5871,7 +5037,7 @@ paths: example: __HPA-CAPABILITY-ID__ - name: body in: body - description: hpa-capability object that needs to be created or updated. + description: hpa-capability object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-capability" @@ -5956,19 +5122,19 @@ paths: required: true type: string example: __FLAVOR-ID__ - - name: cloud-type + - name: hpa-capability-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: hpa-feature in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - - name: flavor-name + - name: architecture in: query - description: Cloud region Flavor name + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -6081,21 +5247,6 @@ paths: required: true type: string example: __FLAVOR-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: flavor-name - in: query - description: Cloud region Flavor name - required: false - type: string put: tags: - CloudInfrastructure @@ -6186,7 +5337,7 @@ paths: example: __FLAVOR-ID__ - name: body in: body - description: flavor object that needs to be created or updated. + description: flavor object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/flavor" @@ -6259,14 +5410,14 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: flavor-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: flavor-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: @@ -6379,26 +5530,6 @@ paths: required: true type: string example: __GROUP-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: group-type - in: query - description: Group type - the type of group this instance refers to - required: false - type: string - - name: group-name - in: query - description: Group name - name assigned to the group - required: false - type: string put: tags: - CloudInfrastructure @@ -6489,7 +5620,7 @@ paths: example: __GROUP-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. + description: group-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/group-assignment" @@ -6562,14 +5693,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: group-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: group-type + in: query + description: + required: false + type: string + - name: group-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: @@ -6682,41 +5818,6 @@ paths: required: true type: string example: __SNAPSHOT-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: snapshot-name - in: query - description: Snapshot name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string - - name: prev-snapshot-id - in: query - description: This field contains the UUID of the previous snapshot (if any). - required: false - type: string put: tags: - CloudInfrastructure @@ -6807,7 +5908,7 @@ paths: example: __SNAPSHOT-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. + description: snapshot object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/snapshot" @@ -6880,14 +5981,34 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: snapshot-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: snapshot-name + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: + required: false + type: string + - name: prev-snapshot-id in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -7005,36 +6126,6 @@ paths: required: true type: string example: __METANAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - CloudInfrastructure @@ -7135,7 +6226,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -7219,34 +6310,9 @@ paths: required: true type: string example: __IMAGE-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version + - name: metaname in: query - description: The version of the application. + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: @@ -7285,36 +6351,6 @@ paths: required: true type: string example: __IMAGE-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - CloudInfrastructure @@ -7405,7 +6441,7 @@ paths: example: __IMAGE-ID__ - name: body in: body - description: image object that needs to be created or updated. + description: image object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/image" @@ -7478,14 +6514,29 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: image-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: image-name + in: query + description: + required: false + type: string + - name: application in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -7598,21 +6649,6 @@ paths: required: true type: string example: __SWITCH-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vcenter-url - in: query - description: URL used to reach the vcenter - required: false - type: string put: tags: - CloudInfrastructure @@ -7703,7 +6739,7 @@ paths: example: __SWITCH-NAME__ - name: body in: body - description: dvs-switch object that needs to be created or updated. + description: dvs-switch object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/dvs-switch" @@ -7776,14 +6812,14 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: switch-name in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vcenter-url in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: @@ -7896,27 +6932,6 @@ paths: required: true type: string example: __NETWORK-UUID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: network-name - in: query - description: Name of the network. - required: false - type: string - - name: cvlan-tag - in: query - description: cvlan-id - required: false - type: integer - format: int64 put: tags: - CloudInfrastructure @@ -8007,7 +7022,7 @@ paths: example: __NETWORK-UUID__ - name: body in: body - description: oam-network object that needs to be created or updated. + description: oam-network object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/oam-network" @@ -8080,16 +7095,22 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: network-uuid in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: network-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string + - name: cvlan-tag + in: query + description: + required: false + type: integer + format: int64 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: put: tags: @@ -8200,16 +7221,6 @@ paths: required: true type: string example: __AVAILABILITY-ZONE-NAME__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string put: tags: - CloudInfrastructure @@ -8300,7 +7311,7 @@ paths: example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: availability-zone object that needs to be created or updated. + description: availability-zone object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/availability-zone" @@ -8373,14 +7384,9 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type + - name: availability-zone-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: @@ -8555,32 +7561,6 @@ paths: required: true type: string example: __VIP-IPV4-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8671,7 +7651,7 @@ paths: example: __VIP-IPV4-ADDRESS__ - name: body in: body - description: vip-ipv4-address-list object that needs to be created or updated. + description: vip-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vip-ipv4-address-list" @@ -8824,32 +7804,6 @@ paths: required: true type: string example: __VIP-IPV6-ADDRESS__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -8940,7 +7894,7 @@ paths: example: __VIP-IPV6-ADDRESS__ - name: body in: body - description: vip-ipv6-address-list object that needs to be created or updated. + description: vip-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vip-ipv6-address-list" @@ -9185,26 +8139,6 @@ paths: required: true type: string example: __HPA-ATTRIBUTE-KEY__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: hpa-feature - in: query - description: Name of the HPACapability - required: false - type: string - - name: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9307,7 +8241,7 @@ paths: example: __HPA-ATTRIBUTE-KEY__ - name: body in: body - description: hpa-feature-attributes object that needs to be created or updated. + description: hpa-feature-attributes object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-feature-attributes" @@ -9392,26 +8326,6 @@ paths: required: true type: string example: __HPA-CAPABILITY-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: hpa-feature - in: query - description: Name of the HPACapability - required: false - type: string - - name: architecture - in: query - description: Hardware architecture - required: false - type: string put: tags: - CloudInfrastructure @@ -9502,7 +8416,7 @@ paths: example: __HPA-CAPABILITY-ID__ - name: body in: body - description: hpa-capability object that needs to be created or updated. + description: hpa-capability object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/hpa-capability" @@ -9575,14 +8489,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type + - name: hpa-capability-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: hpa-feature in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: architecture + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: @@ -9615,16 +8534,6 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string put: tags: - CloudInfrastructure @@ -9703,7 +8612,7 @@ paths: example: __CLOUD-REGION-ID__ - name: body in: body - description: cloud-region object that needs to be created or updated. + description: cloud-region object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/cloud-region" @@ -9757,6 +8666,27 @@ paths: $ref: "#/getDefinitions/cloud-regions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: query + description: + required: false + type: string + - name: cloud-region-id + in: query + description: + required: false + type: string + - name: cloud-type + in: query + description: + required: false + type: string + - name: owner-defined-type + in: query + description: + required: false + type: string /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: put: tags: @@ -9897,7 +8827,7 @@ paths: example: __NM-PROFILE-NAME__ - name: body in: body - description: network-profile object that needs to be created or updated. + description: network-profile object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/network-profile" @@ -9945,6 +8875,12 @@ paths: $ref: "#/getDefinitions/network-profiles" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: query + description: + required: false + type: string /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: put: tags: @@ -10167,30 +9103,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - CloudInfrastructure @@ -10281,7 +9193,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -10354,28 +9266,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -10610,72 +9503,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -10790,7 +9617,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -10991,196 +9818,130 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - example: __HOSTNAME__ - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - example: __VLAN-INTERFACE__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11268,56 +10029,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -11420,7 +10131,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -11505,43 +10216,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -11672,65 +10360,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -11833,7 +10462,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -11918,43 +10547,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: pci-id in: query - description: alternative pserver name + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -12159,61 +10774,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -12316,7 +10876,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -12493,61 +11053,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -12650,7 +11155,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -12735,45 +11240,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -12864,7 +11330,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -12937,28 +11403,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: interface-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: macaddr in: query - description: alternative pserver name + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: @@ -12991,30 +11453,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - CloudInfrastructure @@ -13093,7 +11531,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -13154,23 +11592,14 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: prov-status in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -13467,77 +11896,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -13652,7 +12010,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -13853,77 +12211,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -14038,7 +12325,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -14135,61 +12422,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - CloudInfrastructure @@ -14292,7 +12524,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -14377,48 +12609,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -14549,70 +12753,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - CloudInfrastructure @@ -14715,7 +12855,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -14800,48 +12940,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -15046,66 +13167,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -15208,7 +13269,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -15385,66 +13446,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - CloudInfrastructure @@ -15547,7 +13548,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -15632,50 +13633,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - CloudInfrastructure @@ -15766,7 +13723,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -15839,33 +13796,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id + - name: interface-name in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: interface-id in: query - description: alternative pserver name + description: required: false type: string - - name: interface-id + - name: macaddr in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: @@ -15898,35 +13846,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - CloudInfrastructure @@ -16005,7 +13924,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -16066,23 +13985,19 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: interface-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: interface-role in: query - description: alternative pserver name + description: required: false type: string /cloud-infrastructure/pservers/pserver/{hostname}: @@ -16109,25 +14024,6 @@ paths: required: true type: string example: __HOSTNAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string put: tags: - CloudInfrastructure @@ -16194,7 +14090,7 @@ paths: example: __HOSTNAME__ - name: body in: body - description: pserver object that needs to be created or updated. + description: pserver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/pserver" @@ -16242,6 +14138,32 @@ paths: $ref: "#/getDefinitions/pservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: query + description: + required: false + type: string + - name: inv-status + in: query + description: + required: false + type: string + - name: pserver-id + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: pserver-name2 + in: query + description: + required: false + type: string /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: put: tags: @@ -16316,11 +14238,6 @@ paths: required: true type: string example: __VDC-ID__ - - name: vdc-name - in: query - description: Name of the virtual data center - required: false - type: string put: tags: - CloudInfrastructure @@ -16387,7 +14304,7 @@ paths: example: __VDC-ID__ - name: body in: body - description: virtual-data-center object that needs to be created or updated. + description: virtual-data-center object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/virtual-data-center" @@ -16435,6 +14352,17 @@ paths: $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id + in: query + description: + required: false + type: string + - name: vdc-name + in: query + description: + required: false + type: string /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship: put: tags: @@ -16575,7 +14503,7 @@ paths: example: __OPERATIONAL-ENVIRONMENT-ID__ - name: body in: body - description: operational-environment object that needs to be created or updated. + description: operational-environment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/operational-environment" @@ -16623,6 +14551,12 @@ paths: $ref: "#/getDefinitions/operational-environments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: operational-environment-id + in: query + description: + required: false + type: string /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: @@ -16702,26 +14636,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -16798,7 +14712,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -16858,24 +14772,9 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: metaname in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /business/connectors/connector/{resource-instance-id}: @@ -16902,26 +14801,6 @@ paths: required: true type: string example: __RESOURCE-INSTANCE-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Business @@ -16988,7 +14867,7 @@ paths: example: __RESOURCE-INSTANCE-ID__ - name: body in: body - description: connector object that needs to be created or updated. + description: connector object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/connector" @@ -17036,185 +14915,156 @@ paths: $ref: "#/getDefinitions/connectors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: - put: - tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: - get: - tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/metadatum" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - example: __GLOBAL-CUSTOMER-ID__ - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - example: __SERVICE-TYPE__ - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - example: __SERVICE-INSTANCE-ID__ - - name: metaname - in: path - required: true - type: string - example: __METANAME__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context + - name: resource-instance-id in: query - description: This field will store the workload context assigned to the service-instance. + description: required: false type: string - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. + description: required: false type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: put: tags: - Business - summary: create or update an existing metadatum - description: | - Create or update an existing metadatum. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json - application/xml @@ -17306,7 +15156,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -17390,59 +15240,9 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status + - name: metaname in: query - description: Orchestration status of this service. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship: @@ -17591,81 +15391,6 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role - in: query - description: role in the network that this resource will be providing. - required: false - type: string put: tags: - Business @@ -17780,7 +15505,7 @@ paths: example: __ID__ - name: body in: body - description: tunnel-xconnect object that needs to be created or updated. + description: tunnel-xconnect object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/tunnel-xconnect" @@ -17877,79 +15602,9 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role + - name: id in: query - description: role in the network that this resource will be providing. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship: @@ -18080,81 +15735,6 @@ paths: required: true type: string example: __ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role - in: query - description: role in the network that this resource will be providing. - required: false - type: string put: tags: - Business @@ -18257,7 +15837,7 @@ paths: example: __ID__ - name: body in: body - description: allotted-resource object that needs to be created or updated. + description: allotted-resource object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/allotted-resource" @@ -18342,59 +15922,29 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context + - name: id in: query - description: This field will store the workload context assigned to the service-instance. + description: required: false type: string - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: service-instance-location-id + - name: type in: query - description: An identifier that customers assign to the location where this service is being used. + description: required: false type: string - - name: orchestration-status + - name: role in: query - description: Orchestration status of this service. + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: @@ -18433,61 +15983,6 @@ paths: required: true type: string example: __SERVICE-INSTANCE-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string put: tags: - Business @@ -18578,7 +16073,7 @@ paths: example: __SERVICE-INSTANCE-ID__ - name: body in: body - description: service-instance object that needs to be created or updated. + description: service-instance object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-instance" @@ -18651,14 +16146,54 @@ paths: required: true type: string example: __SERVICE-TYPE__ - - name: subscriber-name + - name: service-instance-id in: query - description: Subscriber name, an alternate way to retrieve a customer. + description: required: false type: string - - name: subscriber-type + - name: service-instance-name + in: query + description: + required: false + type: string + - name: environment-context + in: query + description: + required: false + type: string + - name: workload-context + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: required: false type: string /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: @@ -18753,16 +16288,6 @@ paths: required: true type: string example: __SERVICE-TYPE__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string put: tags: - Business @@ -18841,7 +16366,7 @@ paths: example: __SERVICE-TYPE__ - name: body in: body - description: service-subscription object that needs to be created or updated. + description: service-subscription object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-subscription" @@ -18902,14 +16427,9 @@ paths: required: true type: string example: __GLOBAL-CUSTOMER-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type + - name: service-type in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: required: false type: string /business/customers/customer/{global-customer-id}/relationship-list/relationship: @@ -18986,16 +16506,6 @@ paths: required: true type: string example: __GLOBAL-CUSTOMER-ID__ - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string put: tags: - Business @@ -19062,7 +16572,7 @@ paths: example: __GLOBAL-CUSTOMER-ID__ - name: body in: body - description: customer object that needs to be created or updated. + description: customer object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/customer" @@ -19110,6 +16620,22 @@ paths: $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: put: tags: @@ -19250,7 +16776,7 @@ paths: example: __LINE-OF-BUSINESS-NAME__ - name: body in: body - description: line-of-business object that needs to be created or updated. + description: line-of-business object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/line-of-business" @@ -19298,6 +16824,12 @@ paths: $ref: "#/getDefinitions/lines-of-business" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name + in: query + description: + required: false + type: string /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: put: tags: @@ -19438,7 +16970,7 @@ paths: example: __OWNING-ENTITY-ID__ - name: body in: body - description: owning-entity object that needs to be created or updated. + description: owning-entity object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/owning-entity" @@ -19486,6 +17018,12 @@ paths: $ref: "#/getDefinitions/owning-entities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id + in: query + description: + required: false + type: string /business/platforms/platform/{platform-name}/relationship-list/relationship: put: tags: @@ -19626,7 +17164,7 @@ paths: example: __PLATFORM-NAME__ - name: body in: body - description: platform object that needs to be created or updated. + description: platform object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/platform" @@ -19674,6 +17212,12 @@ paths: $ref: "#/getDefinitions/platforms" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name + in: query + description: + required: false + type: string /business/projects/project/{project-name}/relationship-list/relationship: put: tags: @@ -19814,7 +17358,7 @@ paths: example: __PROJECT-NAME__ - name: body in: body - description: project object that needs to be created or updated. + description: project object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/project" @@ -19862,6 +17406,12 @@ paths: $ref: "#/getDefinitions/projects" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name + in: query + description: + required: false + type: string /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: @@ -19936,21 +17486,6 @@ paths: required: true type: string example: __VNF-IMAGE-UUID__ - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20017,7 +17552,7 @@ paths: example: __VNF-IMAGE-UUID__ - name: body in: body - description: vnf-image object that needs to be created or updated. + description: vnf-image object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vnf-image" @@ -20065,6 +17600,27 @@ paths: $ref: "#/getDefinitions/vnf-images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: + required: false + type: string /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: put: tags: @@ -20139,11 +17695,6 @@ paths: required: true type: string example: __SERVICE-ID__ - - name: service-description - in: query - description: Description of the service - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20210,7 +17761,7 @@ paths: example: __SERVICE-ID__ - name: body in: body - description: service object that needs to be created or updated. + description: service object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service" @@ -20258,6 +17809,17 @@ paths: $ref: "#/getDefinitions/services" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id + in: query + description: + required: false + type: string + - name: service-description + in: query + description: + required: false + type: string /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: put: tags: @@ -20428,7 +17990,7 @@ paths: example: __VNF-TYPE__ - name: body in: body - description: service-capability object that needs to be created or updated. + description: service-capability object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/service-capability" @@ -20482,6 +18044,17 @@ paths: $ref: "#/getDefinitions/service-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship: put: tags: @@ -20634,26 +18207,6 @@ paths: required: true type: string example: __ELEMENT-CHOICE-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -20772,7 +18325,7 @@ paths: example: __ELEMENT-CHOICE-SET-UUID__ - name: body in: body - description: element-choice-set object that needs to be created or updated. + description: element-choice-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/element-choice-set" @@ -20874,24 +18427,9 @@ paths: required: true type: string example: __CONSTRAINED-ELEMENT-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status + - name: element-choice-set-uuid in: query - description: Distribution Status + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship: @@ -21031,26 +18569,6 @@ paths: required: true type: string example: __CONSTRAINED-ELEMENT-SET-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21159,7 +18677,7 @@ paths: example: __CONSTRAINED-ELEMENT-SET-UUID__ - name: body in: body - description: constrained-element-set object that needs to be created or updated. + description: constrained-element-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/constrained-element-set" @@ -21251,24 +18769,9 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status + - name: constrained-element-set-uuid in: query - description: Distribution Status + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}: @@ -21311,232 +18814,197 @@ paths: required: true type: string example: __MODEL-CONSTRAINT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true type: string - - name: model-version + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/model-constraint" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: resource-version in: query - description: Version - required: false + description: resource-version for concurrency + required: true type: string - - name: distribution-status + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: query - description: Distribution Status + description: required: false type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation - summary: create or update an existing model-constraint - description: | - Create or update an existing model-constraint. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) - required: true - schema: - $ref: "#/definitions/model-constraint" - patch: - tags: - - ServiceDesignAndCreation - summary: update an existing model-constraint - description: | - Update an existing model-constraint - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: body - in: body - description: model-constraint object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/model-constraint" - delete: - tags: - - ServiceDesignAndCreation - summary: delete an existing model-constraint - description: delete an existing model-constraint - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-constraint-uuid - in: path - required: true - type: string - example: __MODEL-CONSTRAINT-UUID__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints: - get: - tags: - - ServiceDesignAndCreation - summary: returns model-constraints - description: returns model-constraints - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/model-constraints" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - example: __MODEL-INVARIANT-ID__ - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - example: __MODEL-VERSION-ID__ - - name: model-element-uuid - in: path - required: true - type: string - example: __MODEL-ELEMENT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship: - put: - tags: - - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship consumes: - application/json - application/xml @@ -21638,26 +19106,6 @@ paths: required: true type: string example: __MODEL-ELEMENT-UUID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21746,7 +19194,7 @@ paths: example: __MODEL-ELEMENT-UUID__ - name: body in: body - description: model-element object that needs to be created or updated. + description: model-element object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model-element" @@ -21818,24 +19266,9 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status + - name: model-element-uuid in: query - description: Distribution Status + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: @@ -21873,26 +19306,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -21981,7 +19394,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -22053,24 +19466,9 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status + - name: metaname in: query - description: Distribution Status + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: @@ -22165,26 +19563,6 @@ paths: required: true type: string example: __MODEL-VERSION-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - - name: distribution-status - in: query - description: Distribution Status - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22263,7 +19641,7 @@ paths: example: __MODEL-VERSION-ID__ - name: body in: body - description: model-ver object that needs to be created or updated. + description: model-ver object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model-ver" @@ -22324,9 +19702,24 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type + - name: model-version-id in: query - description: Type of the model, e.g., service, resource, widget, etc. + description: + required: false + type: string + - name: model-name + in: query + description: + required: false + type: string + - name: model-version + in: query + description: + required: false + type: string + - name: distribution-status + in: query + description: required: false type: string /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: @@ -22403,11 +19796,6 @@ paths: required: true type: string example: __MODEL-INVARIANT-ID__ - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22474,7 +19862,7 @@ paths: example: __MODEL-INVARIANT-ID__ - name: body in: body - description: model object that needs to be created or updated. + description: model object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/model" @@ -22522,6 +19910,17 @@ paths: $ref: "#/getDefinitions/models" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-type + in: query + description: + required: false + type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship: put: tags: @@ -22623,10 +20022,6 @@ paths: required: true type: string example: __RELATED-LOOKUP-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22711,7 +20106,7 @@ paths: example: __RELATED-LOOKUP-UUID__ - name: body in: body - description: related-lookup object that needs to be created or updated. + description: related-lookup object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/related-lookup" @@ -22779,8 +20174,9 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name + - name: related-lookup-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}: @@ -22816,10 +20212,6 @@ paths: required: true type: string example: __PROPERTY-CONSTRAINT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -22904,7 +20296,7 @@ paths: example: __PROPERTY-CONSTRAINT-UUID__ - name: body in: body - description: property-constraint object that needs to be created or updated. + description: property-constraint object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/property-constraint" @@ -22972,8 +20364,9 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name + - name: property-constraint-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: @@ -23062,10 +20455,6 @@ paths: required: true type: string example: __NAMED-QUERY-ELEMENT-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23140,7 +20529,7 @@ paths: example: __NAMED-QUERY-ELEMENT-UUID__ - name: body in: body - description: named-query-element object that needs to be created or updated. + description: named-query-element object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/named-query-element" @@ -23198,8 +20587,9 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name + - name: named-query-element-uuid in: query + description: required: false type: string /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: @@ -23273,10 +20663,6 @@ paths: required: true type: string example: __NAMED-QUERY-UUID__ - - name: named-query-name - in: query - required: false - type: string put: tags: - ServiceDesignAndCreation @@ -23341,7 +20727,7 @@ paths: example: __NAMED-QUERY-UUID__ - name: body in: body - description: named-query object that needs to be created or updated. + description: named-query object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/named-query" @@ -23388,6 +20774,17 @@ paths: $ref: "#/getDefinitions/named-queries" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: query + description: + required: false + type: string + - name: named-query-name + in: query + description: + required: false + type: string /network/logical-links/logical-link/{link-name}/relationship-list/relationship: put: tags: @@ -23462,46 +20859,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: link-id - in: query - description: UUID of the logical-link, SDNC generates this. - required: false - type: string - - name: circuit-id - in: query - description: Circuit id - required: false - type: string - - name: purpose - in: query - description: Reason for this entity, role it is playing - required: false - type: string put: tags: - Network @@ -23568,7 +20925,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: logical-link object that needs to be created or updated. + description: logical-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/logical-link" @@ -23616,6 +20973,52 @@ paths: $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: link-id + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + - name: purpose + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship: put: tags: @@ -23846,7 +21249,7 @@ paths: example: __COS__ - name: body in: body - description: class-of-service object that needs to be created or updated. + description: class-of-service object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/class-of-service" @@ -23931,6 +21334,11 @@ paths: required: true type: string example: __SITE-PAIR-ID__ + - name: cos + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship: put: tags: @@ -24131,7 +21539,7 @@ paths: example: __SITE-PAIR-ID__ - name: body in: body - description: site-pair object that needs to be created or updated. + description: site-pair object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/site-pair" @@ -24204,6 +21612,11 @@ paths: required: true type: string example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: put: tags: @@ -24374,7 +21787,7 @@ paths: example: __ROUTING-INSTANCE-ID__ - name: body in: body - description: routing-instance object that needs to be created or updated. + description: routing-instance object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/routing-instance" @@ -24435,6 +21848,11 @@ paths: required: true type: string example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: query + description: + required: false + type: string /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: put: tags: @@ -24575,7 +21993,7 @@ paths: example: __SITE-PAIR-SET-ID__ - name: body in: body - description: site-pair-set object that needs to be created or updated. + description: site-pair-set object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/site-pair-set" @@ -24623,135 +22041,131 @@ paths: $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: - get: - tags: - - Network - summary: returns route-target - description: returns route-target - operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/route-target" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vpn-id - in: path - description: VPN ID, globally unique within A&AI - required: true - type: string - example: __VPN-ID__ - - name: global-route-target - in: path - description: Number used to identify an RT, globally unique in the network - required: true - type: string - example: __GLOBAL-ROUTE-TARGET__ - - name: route-target-role - in: path - description: Role assigned to this route target - required: true - type: string - example: __ROUTE-TARGET-ROLE__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type + - name: site-pair-set-id in: query - description: Type of the vpn, should be taken from enumerated/valid values + description: required: false type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing route-target - description: | - Create or update an existing route-target. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: + tags: + - Network + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: global-route-target + in: path + description: Number used to identify an RT, globally unique in the network + required: true + type: string + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role + in: path + description: Role assigned to this route target + required: true + type: string + example: __ROUTE-TARGET-ROLE__ + put: + tags: + - Network + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -24833,7 +22247,7 @@ paths: example: __ROUTE-TARGET-ROLE__ - name: body in: body - description: route-target object that needs to be created or updated. + description: route-target object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/route-target" @@ -24900,16 +22314,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: @@ -24984,16 +22388,6 @@ paths: required: true type: string example: __VPN-ID__ - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false - type: string put: tags: - Network @@ -25060,7 +22454,7 @@ paths: example: __VPN-ID__ - name: body in: body - description: vpn-binding object that needs to be created or updated. + description: vpn-binding object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vpn-binding" @@ -25108,6 +22502,22 @@ paths: $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: query + description: + required: false + type: string + - name: vpn-name + in: query + description: + required: false + type: string + - name: vpn-type + in: query + description: + required: false + type: string /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: @@ -25323,16 +22733,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -25421,7 +22821,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -25492,14 +22892,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -25729,58 +23124,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -25893,7 +23236,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -26090,58 +23433,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -26254,7 +23545,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -26349,42 +23640,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -26485,7 +23740,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -26568,29 +23823,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -26718,51 +23964,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -26863,7 +24064,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -26946,29 +24147,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: pci-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -27168,47 +24369,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -27309,7 +24469,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -27482,47 +24642,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -27623,7 +24742,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -27706,31 +24825,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -27819,7 +24913,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -27890,14 +24984,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: interface-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: @@ -27929,16 +25033,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -28015,7 +25109,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -28074,9 +25168,14 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ + - name: interface-name + in: query + description: + required: false + type: string - name: prov-status in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -28366,63 +25465,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -28535,7 +25577,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -28732,63 +25774,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -28901,7 +25886,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -28996,47 +25981,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -29137,7 +26081,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -29220,34 +26164,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -29375,56 +26305,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -29525,7 +26405,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -29608,34 +26488,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -29835,52 +26710,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -29981,7 +26810,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -30154,162 +26983,116 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: | - Create or update an existing l3-interface-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - patch: - tags: - - Network - summary: update an existing l3-interface-ipv6-address-list - description: | - Update an existing l3-interface-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - example: __EQUIPMENT-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" - delete: - tags: - - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -30383,36 +27166,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -30501,7 +27254,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -30572,19 +27325,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status + - name: interface-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - name: interface-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: @@ -30616,21 +27374,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -30707,7 +27450,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -30766,9 +27509,19 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status + - name: interface-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/vpls-pes/vpls-pe/{equipment-name}: @@ -30794,11 +27547,6 @@ paths: required: true type: string example: __EQUIPMENT-NAME__ - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string put: tags: - Network @@ -30863,7 +27611,7 @@ paths: example: __EQUIPMENT-NAME__ - name: body in: body - description: vpls-pe object that needs to be created or updated. + description: vpls-pe object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vpls-pe" @@ -30910,6 +27658,17 @@ paths: $ref: "#/getDefinitions/vpls-pes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: put: tags: @@ -31050,7 +27809,7 @@ paths: example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: multicast-configuration object that needs to be created or updated. + description: multicast-configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/multicast-configuration" @@ -31098,6 +27857,12 @@ paths: $ref: "#/getDefinitions/multicast-configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: query + description: + required: false + type: string /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: put: tags: @@ -31211,61 +27976,6 @@ paths: type: integer format: int64 example: __CVLAN-TAG__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -31358,7 +28068,7 @@ paths: example: __CVLAN-TAG__ - name: body in: body - description: cvlan-tag-entry object that needs to be created or updated. + description: cvlan-tag-entry object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/cvlan-tag-entry" @@ -31432,61 +28142,12 @@ paths: required: true type: string example: __INTERFACE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id + - name: cvlan-tag in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false - type: string + type: integer + format: int64 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: put: tags: @@ -31579,61 +28240,6 @@ paths: required: true type: string example: __INTERFACE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false - type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -31712,7 +28318,7 @@ paths: example: __INTERFACE-ID__ - name: body in: body - description: port-group object that needs to be created or updated. + description: port-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/port-group" @@ -31773,44 +28379,24 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id + - name: interface-id in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + description: required: false type: string - - name: regional-resource-zone + - name: port-group-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: switch-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -31923,46 +28509,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -32053,7 +28599,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: license object that needs to be created or updated. + description: license object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/license" @@ -32120,44 +28666,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id + - name: group-uuid in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: vpe-id + - name: resource-uuid in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -32270,46 +28786,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -32400,7 +28876,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: entitlement object that needs to be created or updated. + description: entitlement object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/entitlement" @@ -32467,44 +28943,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id + - name: group-uuid in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: vpe-id + - name: resource-uuid in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string /network/vces/vce/{vnf-id}/relationship-list/relationship: @@ -32581,46 +29027,6 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string put: tags: - Network @@ -32687,7 +29093,7 @@ paths: example: __VNF-ID__ - name: body in: body - description: vce object that needs to be created or updated. + description: vce object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vce" @@ -32735,6 +29141,52 @@ paths: $ref: "#/getDefinitions/vces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: query + description: + required: false + type: string + - name: vnf-name + in: query + description: + required: false + type: string + - name: vnf-name2 + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: regional-resource-zone + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: vpe-id + in: query + description: + required: false + type: string /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: put: tags: @@ -32877,65 +29329,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -33014,7 +29407,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -33143,65 +29536,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -33280,7 +29614,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -33341,49 +29675,6 @@ paths: required: true type: string example: __VNFC-NAME__ - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -33450,7 +29741,7 @@ paths: example: __VNFC-NAME__ - name: body in: body - description: vnfc object that needs to be created or updated. + description: vnfc object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vnfc" @@ -33498,6 +29789,57 @@ paths: $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: query + description: + required: false + type: string + - name: nfc-naming-code + in: query + description: + required: false + type: string + - name: nfc-function + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: ipaddress-v4-oam-vip + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: group-notation + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship: put: tags: @@ -33608,56 +29950,6 @@ paths: required: true type: string example: __HOST-ROUTE-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -33748,7 +30040,7 @@ paths: example: __HOST-ROUTE-ID__ - name: body in: body - description: host-route object that needs to be created or updated. + description: host-route object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/host-route" @@ -33821,54 +30113,9 @@ paths: required: true type: string example: __SUBNET-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name + - name: host-route-id in: query - description: Name associated with the subnet. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: @@ -33963,56 +30210,6 @@ paths: required: true type: string example: __SUBNET-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string put: tags: - Network @@ -34091,7 +30288,7 @@ paths: example: __SUBNET-ID__ - name: body in: body - description: subnet object that needs to be created or updated. + description: subnet object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/subnet" @@ -34152,49 +30349,14 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: subnet-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: subnet-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: @@ -34292,51 +30454,6 @@ paths: type: integer format: int64 example: __VLAN-ID-INNER__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -34417,7 +30534,7 @@ paths: example: __VLAN-ID-INNER__ - name: body in: body - description: ctag-assignment object that needs to be created or updated. + description: ctag-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ctag-assignment" @@ -34479,51 +30596,12 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: vlan-id-inner in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false - type: string + type: integer + format: int64 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: put: tags: @@ -34616,51 +30694,6 @@ paths: required: true type: string example: __SEGMENTATION-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -34739,7 +30772,7 @@ paths: example: __SEGMENTATION-ID__ - name: body in: body - description: segmentation-assignment object that needs to be created or updated. + description: segmentation-assignment object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/segmentation-assignment" @@ -34800,49 +30833,9 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: segmentation-id in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: @@ -34919,51 +30912,6 @@ paths: required: true type: string example: __NETWORK-ID__ - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string put: tags: - Network @@ -35030,7 +30978,7 @@ paths: example: __NETWORK-ID__ - name: body in: body - description: l3-network object that needs to be created or updated. + description: l3-network object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-network" @@ -35078,6 +31026,57 @@ paths: $ref: "#/getDefinitions/l3-networks" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + - name: network-role + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: contrail-network-fqdn + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: @@ -35152,11 +31151,6 @@ paths: required: true type: string example: __NETWORK-POLICY-ID__ - - name: network-policy-fqdn - in: query - description: Contrail FQDN for the policy - required: false - type: string put: tags: - Network @@ -35223,7 +31217,7 @@ paths: example: __NETWORK-POLICY-ID__ - name: body in: body - description: network-policy object that needs to be created or updated. + description: network-policy object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/network-policy" @@ -35271,6 +31265,17 @@ paths: $ref: "#/getDefinitions/network-policies" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: query + description: + required: false + type: string + - name: network-policy-fqdn + in: query + description: + required: false + type: string /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: put: tags: @@ -35523,131 +31528,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -35750,7 +31630,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -35927,131 +31807,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -36154,7 +31909,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -36239,115 +31994,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -36438,7 +32084,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -36511,102 +32157,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -36719,124 +32283,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -36927,7 +32373,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -37000,102 +32446,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -37270,120 +32643,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -37474,7 +32733,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -37627,120 +32886,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -37831,7 +32976,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -37904,104 +33049,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -38080,7 +33127,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -38141,87 +33188,24 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type + - name: interface-name in: query - description: Generic description of the type of NF + description: required: false type: string - - name: nf-function + - name: interface-id in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: macaddr in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: network-name in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -38518,141 +33502,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -38767,7 +33616,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -38968,141 +33817,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -39217,7 +33931,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -39314,125 +34028,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -39535,7 +34130,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -39620,112 +34215,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -39856,134 +34359,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -40086,7 +34461,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -40171,112 +34546,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -40481,159 +34773,35 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: - tags: - - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: | - Create or update an existing l3-interface-ipv4-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - example: __VNF-ID__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string example: __INTERFACE-NAME__ - name: interface-name @@ -40707,7 +34875,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -40884,130 +35052,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -41110,7 +35154,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -41195,114 +35239,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -41393,7 +35329,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -41466,97 +35402,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: interface-name in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: interface-id in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - - name: interface-id + - name: macaddr in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: network-name in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: @@ -41589,99 +35452,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -41760,7 +35530,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -41821,87 +35591,19 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function + - name: interface-name in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: interface-id in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: interface-role in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: @@ -41996,124 +35698,6 @@ paths: required: true type: string example: __VF-MODULE-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: vf-module-name - in: query - description: Name of vf-module - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - required: false - type: string put: tags: - Network @@ -42192,7 +35776,7 @@ paths: example: __VF-MODULE-ID__ - name: body in: body - description: vf-module object that needs to be created or updated. + description: vf-module object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vf-module" @@ -42253,87 +35837,44 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone + - name: vf-module-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-module-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code + - name: contrail-service-instance-fqdn in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -42446,89 +35987,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string put: tags: - Network @@ -42619,7 +36077,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: license object that needs to be created or updated. + description: license object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/license" @@ -42686,87 +36144,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: group-uuid in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: resource-uuid in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: @@ -42879,89 +36264,6 @@ paths: required: true type: string example: __RESOURCE-UUID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string put: tags: - Network @@ -43052,7 +36354,7 @@ paths: example: __RESOURCE-UUID__ - name: body in: body - description: entitlement object that needs to be created or updated. + description: entitlement object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/entitlement" @@ -43119,87 +36421,14 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role + - name: group-uuid in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: resource-uuid in: query - description: string assigned to this model used for naming purposes + description: required: false type: string /network/generic-vnfs/generic-vnf/{vnf-id}: @@ -43226,89 +36455,6 @@ paths: required: true type: string example: __VNF-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string put: tags: - Network @@ -43375,7 +36521,7 @@ paths: example: __VNF-ID__ - name: body in: body - description: generic-vnf object that needs to be created or updated. + description: generic-vnf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/generic-vnf" @@ -43423,6 +36569,97 @@ paths: $ref: "#/getDefinitions/generic-vnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: query + description: + required: false + type: string + - name: vnf-name + in: query + description: + required: false + type: string + - name: vnf-name2 + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string + - name: service-id + in: query + description: + required: false + type: string + - name: regional-resource-zone + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: nf-type + in: query + description: + required: false + type: string + - name: nf-function + in: query + description: + required: false + type: string + - name: nf-role + in: query + description: + required: false + type: string + - name: nf-naming-code + in: query + description: + required: false + type: string /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: @@ -43563,7 +36800,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: lag-link object that needs to be created or updated. + description: lag-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-link" @@ -43611,6 +36848,12 @@ paths: $ref: "#/getDefinitions/lag-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: put: tags: @@ -43863,73 +37106,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -44032,7 +37208,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -44209,73 +37385,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -44378,7 +37487,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -44463,57 +37572,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -44604,7 +37662,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -44677,44 +37735,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -44751,142 +37785,82 @@ paths: required: true type: string example: __PCI-ID__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - example: __PCI-ID__ - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: - tags: - - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/sriov-vf" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id2 - in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object - required: true - type: string - example: __VNF-ID2__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - example: __PCI-ID__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + example: __PCI-ID__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string + example: __PCI-ID__ put: tags: - Network @@ -44977,7 +37951,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -45050,44 +38024,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status + - name: pci-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-vlan-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -45262,62 +38221,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -45408,7 +38311,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -45561,62 +38464,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -45707,7 +38554,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -45780,46 +38627,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -45898,7 +38705,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -45959,29 +38766,24 @@ paths: required: true type: string example: __VNF-ID2__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 + - name: interface-name in: query - description: Alternate name of VNF. + description: required: false type: string - - name: vnf-type + - name: interface-id in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. + description: required: false type: string - - name: prov-status + - name: macaddr in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: network-name in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string /network/newvces/newvce/{vnf-id2}: @@ -46008,31 +38810,6 @@ paths: required: true type: string example: __VNF-ID2__ - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string put: tags: - Network @@ -46099,7 +38876,7 @@ paths: example: __VNF-ID2__ - name: body in: body - description: newvce object that needs to be created or updated. + description: newvce object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/newvce" @@ -46147,6 +38924,37 @@ paths: $ref: "#/getDefinitions/newvces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: query + description: + required: false + type: string + - name: vnf-name + in: query + description: + required: false + type: string + - name: vnf-name2 + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: put: tags: @@ -46369,16 +39177,6 @@ paths: required: true type: string example: __PF-PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -46469,7 +39267,7 @@ paths: example: __PF-PCI-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated. + description: sriov-pf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-pf" @@ -46542,14 +39340,9 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status + - name: pf-pci-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: @@ -46784,58 +39577,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -46950,7 +39691,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -47151,58 +39892,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -47317,7 +40006,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -47414,42 +40103,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -47552,7 +40205,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -47637,29 +40290,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -47790,51 +40434,6 @@ paths: required: true type: string example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string put: tags: - Network @@ -47937,7 +40536,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -48022,29 +40621,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: pci-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -48249,47 +40848,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -48392,7 +40950,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -48569,47 +41127,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -48712,7 +41229,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -48797,31 +41314,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -48912,7 +41404,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -48985,14 +41477,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: prov-status + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: @@ -49025,16 +41527,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string put: tags: - Network @@ -49113,7 +41605,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: p-interface object that needs to be created or updated. + description: p-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/p-interface" @@ -49174,9 +41666,14 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: + required: false + type: string + - name: prov-status + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: @@ -49473,63 +41970,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -49644,7 +42084,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -49845,63 +42285,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -50016,7 +42399,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -50113,47 +42496,6 @@ paths: required: true type: string example: __VLAN-INTERFACE__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string put: tags: - Network @@ -50256,7 +42598,7 @@ paths: example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated. + description: vlan object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vlan" @@ -50341,34 +42683,20 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: @@ -50457,98 +42785,48 @@ paths: required: true type: string example: __PCI-ID__ - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: - tags: - - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/sriov-vf" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - example: __PNF-NAME__ - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - example: __INTERFACE-NAME__ - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string - example: __PCI-ID__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string + example: __PCI-ID__ put: tags: - Network @@ -50651,7 +42929,7 @@ paths: example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated. + description: sriov-vf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/sriov-vf" @@ -50736,34 +43014,29 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vf-vlan-filter in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: @@ -50968,52 +43241,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV4-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -51116,7 +43343,7 @@ paths: example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated. + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" @@ -51293,52 +43520,6 @@ paths: required: true type: string example: __L3-INTERFACE-IPV6-ADDRESS__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string put: tags: - Network @@ -51441,7 +43622,7 @@ paths: example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated. + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" @@ -51526,36 +43707,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string put: tags: - Network @@ -51646,7 +43797,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated. + description: l-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/l-interface" @@ -51719,19 +43870,24 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status + - name: interface-name in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - name: interface-id in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: macaddr in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: + required: false + type: string + - name: network-name + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: @@ -51764,21 +43920,6 @@ paths: required: true type: string example: __INTERFACE-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string put: tags: - Network @@ -51857,7 +43998,7 @@ paths: example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated. + description: lag-interface object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/lag-interface" @@ -51918,9 +44059,19 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: + required: false + type: string + - name: interface-role + in: query + description: required: false type: string /network/pnfs/pnf/{pnf-name}: @@ -51947,11 +44098,6 @@ paths: required: true type: string example: __PNF-NAME__ - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string put: tags: - Network @@ -52018,7 +44164,7 @@ paths: example: __PNF-NAME__ - name: body in: body - description: pnf object that needs to be created or updated. + description: pnf object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/pnf" @@ -52066,6 +44212,17 @@ paths: $ref: "#/getDefinitions/pnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: query + description: + required: false + type: string + - name: inv-status + in: query + description: + required: false + type: string /network/physical-links/physical-link/{link-name}/relationship-list/relationship: put: tags: @@ -52140,11 +44297,6 @@ paths: required: true type: string example: __LINK-NAME__ - - name: circuit-id - in: query - description: Circuit it - required: false - type: string put: tags: - Network @@ -52211,7 +44363,7 @@ paths: example: __LINK-NAME__ - name: body in: body - description: physical-link object that needs to be created or updated. + description: physical-link object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/physical-link" @@ -52259,6 +44411,17 @@ paths: $ref: "#/getDefinitions/physical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: put: tags: @@ -52479,7 +44642,7 @@ paths: example: __VIG-ADDRESS-TYPE__ - name: body in: body - description: vig-server object that needs to be created or updated. + description: vig-server object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/vig-server" @@ -52540,6 +44703,11 @@ paths: required: true type: string example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: query + description: + required: false + type: string /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: get: tags: @@ -52630,7 +44798,7 @@ paths: example: __IPSEC-CONFIGURATION-ID__ - name: body in: body - description: ipsec-configuration object that needs to be created or updated. + description: ipsec-configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ipsec-configuration" @@ -52678,6 +44846,12 @@ paths: $ref: "#/getDefinitions/ipsec-configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: query + description: + required: false + type: string /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: put: tags: @@ -52752,11 +44926,6 @@ paths: required: true type: string example: __ROUTE-TABLE-REFERENCE-ID__ - - name: route-table-reference-fqdn - in: query - description: FQDN entry in the route table. - required: false - type: string put: tags: - Network @@ -52823,7 +44992,7 @@ paths: example: __ROUTE-TABLE-REFERENCE-ID__ - name: body in: body - description: route-table-reference object that needs to be created or updated. + description: route-table-reference object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/route-table-reference" @@ -52871,6 +45040,17 @@ paths: $ref: "#/getDefinitions/route-table-references" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: query + description: + required: false + type: string + - name: route-table-reference-fqdn + in: query + description: + required: false + type: string /network/instance-groups/instance-group/{id}/relationship-list/relationship: put: tags: @@ -52945,21 +45125,6 @@ paths: required: true type: string example: __ID__ - - name: description - in: query - description: Descriptive text to help identify the usage of this instance-group - required: false - type: string - - name: type - in: query - description: Only valid value today is lower case ha for high availability - required: false - type: string - - name: sub-type - in: query - description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] - required: false - type: string put: tags: - Network @@ -53026,7 +45191,7 @@ paths: example: __ID__ - name: body in: body - description: instance-group object that needs to be created or updated. + description: instance-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/instance-group" @@ -53074,6 +45239,27 @@ paths: $ref: "#/getDefinitions/instance-groups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: query + description: + required: false + type: string + - name: description + in: query + description: + required: false + type: string + - name: type + in: query + description: + required: false + type: string + - name: sub-type + in: query + description: + required: false + type: string /network/zones/zone/{zone-id}/relationship-list/relationship: put: tags: @@ -53148,16 +45334,6 @@ paths: required: true type: string example: __ZONE-ID__ - - name: design-type - in: query - description: Design of zone [Medium/Large…] - required: false - type: string - - name: zone-context - in: query - description: Context of zone [production/test] - required: false - type: string put: tags: - Network @@ -53224,7 +45400,7 @@ paths: example: __ZONE-ID__ - name: body in: body - description: zone object that needs to be created or updated. + description: zone object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/zone" @@ -53272,6 +45448,22 @@ paths: $ref: "#/getDefinitions/zones" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: query + description: + required: false + type: string + - name: design-type + in: query + description: + required: false + type: string + - name: zone-context + in: query + description: + required: false + type: string /network/configurations/configuration/{configuration-id}/relationship-list/relationship: put: tags: @@ -53351,16 +45543,6 @@ paths: required: true type: string example: __METANAME__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -53437,7 +45619,7 @@ paths: example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: metadatum object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/metadatum" @@ -53497,14 +45679,9 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id + - name: metaname in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship: @@ -53599,16 +45776,6 @@ paths: required: true type: string example: __FORWARDER-EVC-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -53687,7 +45854,7 @@ paths: example: __FORWARDER-EVC-ID__ - name: body in: body - description: forwarder-evc object that needs to be created or updated. + description: forwarder-evc object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/forwarder-evc" @@ -53748,16 +45915,6 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship: put: tags: @@ -53850,16 +46007,6 @@ paths: required: true type: string example: __EVC-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -53938,7 +46085,7 @@ paths: example: __EVC-ID__ - name: body in: body - description: evc object that needs to be created or updated. + description: evc object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/evc" @@ -53999,16 +46146,6 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string /network/configurations/configuration/{configuration-id}: get: tags: @@ -54033,16 +46170,6 @@ paths: required: true type: string example: __CONFIGURATION-ID__ - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string put: tags: - Network @@ -54109,7 +46236,7 @@ paths: example: __CONFIGURATION-ID__ - name: body in: body - description: configuration object that needs to be created or updated. + description: configuration object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/configuration" @@ -54157,6 +46284,22 @@ paths: $ref: "#/getDefinitions/configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship: put: tags: @@ -54302,11 +46445,6 @@ paths: type: integer format: int32 example: __SEQUENCE__ - - name: forwarding-path-name - in: query - description: Name of the FP - required: false - type: string put: tags: - Network @@ -54387,7 +46525,7 @@ paths: example: __SEQUENCE__ - name: body in: body - description: forwarder object that needs to be created or updated. + description: forwarder object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/forwarder" @@ -54449,11 +46587,12 @@ paths: required: true type: string example: __FORWARDING-PATH-ID__ - - name: forwarding-path-name + - name: sequence in: query - description: Name of the FP + description: required: false - type: string + type: integer + format: int32 /network/forwarding-paths/forwarding-path/{forwarding-path-id}: get: tags: @@ -54478,11 +46617,6 @@ paths: required: true type: string example: __FORWARDING-PATH-ID__ - - name: forwarding-path-name - in: query - description: Name of the FP - required: false - type: string put: tags: - Network @@ -54549,7 +46683,7 @@ paths: example: __FORWARDING-PATH-ID__ - name: body in: body - description: forwarding-path object that needs to be created or updated. + description: forwarding-path object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/forwarding-path" @@ -54597,13 +46731,18 @@ paths: $ref: "#/getDefinitions/forwarding-paths" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: forwarding-path-id + in: query + description: + required: false + type: string + - name: forwarding-path-name + in: query + description: + required: false + type: string definitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -54632,21 +46771,24 @@ definitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( allotted-resource IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -54703,15 +46845,18 @@ definitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -54779,7 +46924,9 @@ definitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -54839,27 +46986,29 @@ definitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -54891,6 +47040,7 @@ definitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -54963,20 +47113,22 @@ definitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -55046,19 +47198,21 @@ definitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - TO l-interface( configuration AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) + - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) + - FROM evc( evc BelongsTo configuration, ONE2ONE)(1) + - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -55138,10 +47292,11 @@ definitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -55186,10 +47341,12 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -55220,8 +47377,10 @@ definitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -55246,10 +47405,12 @@ definitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -55284,8 +47445,9 @@ definitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -55344,8 +47506,9 @@ definitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -55421,9 +47584,11 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -55454,8 +47619,10 @@ definitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -55485,8 +47652,9 @@ definitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -55512,10 +47680,12 @@ definitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -55597,9 +47767,10 @@ definitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -55631,8 +47802,9 @@ definitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -55664,7 +47836,9 @@ definitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -55754,10 +47928,12 @@ definitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER + required: - flavor-id - flavor-name @@ -55821,12 +47997,14 @@ definitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -55848,7 +48026,9 @@ definitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -55890,11 +48070,13 @@ definitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -55929,44 +48111,41 @@ definitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -56070,8 +48249,10 @@ definitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -56182,9 +48363,10 @@ definitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -56220,7 +48402,9 @@ definitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -56263,10 +48447,11 @@ definitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -56298,7 +48483,9 @@ definitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -56319,11 +48506,13 @@ definitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -56396,22 +48585,20 @@ definitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -56475,13 +48662,9 @@ definitions: network: type: object $ref: "#/definitions/network" - aai-internal: - type: object - $ref: "#/definitions/aai-internal" nodes: - type: array - items: - $ref: "#/definitions/aai-internal" + type: object + $ref: "#/definitions/nodes" inventory-item: properties: inventory-item-type: @@ -56526,9 +48709,10 @@ definitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -56622,26 +48806,28 @@ definitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1) + - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM configuration( configuration AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -56677,16 +48863,19 @@ definitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. @@ -56726,12 +48915,14 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -56770,12 +48961,14 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -56814,24 +49007,25 @@ definitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -56860,6 +49054,7 @@ definitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -56905,10 +49100,13 @@ definitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. @@ -56942,17 +49140,19 @@ definitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -56983,6 +49183,7 @@ definitions: description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: @@ -57003,8 +49204,10 @@ definitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -57030,8 +49233,10 @@ definitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -57061,7 +49266,8 @@ definitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -57087,24 +49293,27 @@ definitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO l-interface( logical-link Source l-interface, ONE2MANY)(4) + - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link IsA model-ver, Many2One) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also + -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -57115,6 +49324,7 @@ definitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -57193,11 +49403,13 @@ definitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -57213,13 +49425,15 @@ definitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -57262,9 +49476,11 @@ definitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -57290,14 +49506,16 @@ definitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -57340,18 +49558,21 @@ definitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM allotted-resource( allotted-resource IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf IsA model-ver, Many2One) + - FROM l3-network( l3-network IsA model-ver, Many2One) + - FROM logical-link( logical-link IsA model-ver, Many2One) + - FROM service-instance( service-instance IsA model-ver, Many2One) + - FROM vf-module( vf-module IsA model-ver, Many2One) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -57404,7 +49625,8 @@ definitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -57444,10 +49666,11 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -57477,13 +49700,15 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -57612,8 +49837,9 @@ definitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -57637,7 +49863,8 @@ definitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -57666,8 +49893,9 @@ definitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -57731,6 +49959,12 @@ definitions: type: array items: $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -57786,9 +50020,10 @@ definitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -57830,8 +50065,9 @@ definitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -57926,7 +50162,8 @@ definitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -57948,17 +50185,19 @@ definitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -57998,6 +50237,7 @@ definitions: description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status @@ -58025,7 +50265,9 @@ definitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -58083,7 +50325,8 @@ definitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -58109,17 +50352,18 @@ definitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration AppliesTo pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -58159,6 +50403,7 @@ definitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -58216,9 +50461,11 @@ definitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -58274,7 +50521,8 @@ definitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -58308,7 +50556,9 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -58335,19 +50585,20 @@ definitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -58417,6 +50668,7 @@ definitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -58469,7 +50721,9 @@ definitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -58580,7 +50834,8 @@ definitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -58610,7 +50865,9 @@ definitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -58639,9 +50896,11 @@ definitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -58722,7 +50981,9 @@ definitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -58782,9 +51043,11 @@ definitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -58830,37 +51093,34 @@ definitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance IsA model-ver, Many2One) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -58958,10 +51218,12 @@ definitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -59001,9 +51263,11 @@ definitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -59040,9 +51304,10 @@ definitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -59080,8 +51345,9 @@ definitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -59134,8 +51400,10 @@ definitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -59161,8 +51429,10 @@ definitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -59229,14 +51499,17 @@ definitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -59267,6 +51540,7 @@ definitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -59310,13 +51584,15 @@ definitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -59353,7 +51629,9 @@ definitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id properties: @@ -59415,14 +51693,15 @@ definitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -59513,13 +51792,16 @@ definitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + - TO model-ver( vf-module IsA model-ver, Many2One) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -59538,6 +51820,7 @@ definitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -59585,7 +51868,9 @@ definitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -59615,10 +51900,11 @@ definitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -59657,10 +51943,11 @@ definitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -59699,9 +51986,10 @@ definitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -59731,15 +52019,17 @@ definitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -59779,11 +52069,13 @@ definitions: description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. relationship-list: type: array items: @@ -59815,8 +52107,10 @@ definitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -59855,15 +52149,17 @@ definitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -59891,8 +52187,10 @@ definitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -59929,7 +52227,9 @@ definitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -59951,11 +52251,12 @@ definitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -60009,11 +52310,12 @@ definitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -60059,12 +52361,14 @@ definitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -60112,19 +52416,20 @@ definitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -60149,8 +52454,10 @@ definitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -60178,11 +52485,12 @@ definitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -60220,12 +52528,6 @@ definitions: items: $ref: "#/definitions/zone" patchDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -60254,21 +52556,24 @@ patchDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( allotted-resource IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -60302,15 +52607,18 @@ patchDefinitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -60371,7 +52679,9 @@ patchDefinitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -60424,27 +52734,29 @@ patchDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -60476,6 +52788,7 @@ patchDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -60492,20 +52805,22 @@ patchDefinitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -60539,19 +52854,21 @@ patchDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - TO l-interface( configuration AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) + - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) + - FROM evc( evc BelongsTo configuration, ONE2ONE)(1) + - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -60612,10 +52929,11 @@ patchDefinitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -60634,10 +52952,12 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -60658,8 +52978,10 @@ patchDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -60677,10 +52999,12 @@ patchDefinitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -60708,8 +53032,9 @@ patchDefinitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -60750,8 +53075,9 @@ patchDefinitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -60820,9 +53146,11 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -60843,8 +53171,10 @@ patchDefinitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -60867,8 +53197,9 @@ patchDefinitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -60885,10 +53216,12 @@ patchDefinitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -60964,9 +53297,10 @@ patchDefinitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -60989,8 +53323,9 @@ patchDefinitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -61013,7 +53348,9 @@ patchDefinitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -61096,10 +53433,12 @@ patchDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER + required: - flavor-id - flavor-name @@ -61156,12 +53495,14 @@ patchDefinitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -61176,7 +53517,9 @@ patchDefinitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -61211,11 +53554,13 @@ patchDefinitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -61236,44 +53581,41 @@ patchDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -61377,8 +53719,10 @@ patchDefinitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node generic-vnfs: description: | Collection of VNFs @@ -61391,9 +53735,10 @@ patchDefinitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -61422,7 +53767,9 @@ patchDefinitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -61458,10 +53805,11 @@ patchDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -61482,7 +53830,9 @@ patchDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -61496,11 +53846,13 @@ patchDefinitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -61562,22 +53914,20 @@ patchDefinitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -61634,13 +53984,9 @@ patchDefinitions: network: type: object $ref: "#/patchDefinitions/network" - aai-internal: - type: object - $ref: "#/patchDefinitions/aai-internal" nodes: - type: array - items: - $ref: "#/patchDefinitions/aai-internal" + type: object + $ref: "#/patchDefinitions/nodes" inventory-item: properties: inventory-item-type: @@ -61685,9 +54031,10 @@ patchDefinitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -61770,26 +54117,28 @@ patchDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1) + - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM configuration( configuration AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -61825,6 +54174,7 @@ patchDefinitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. l-interfaces: description: | Collection of logical interfaces. @@ -61837,12 +54187,14 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -61868,12 +54220,14 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -61899,24 +54253,25 @@ patchDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -61945,6 +54300,7 @@ patchDefinitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -61962,17 +54318,19 @@ patchDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -61995,8 +54353,10 @@ patchDefinitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -62015,8 +54375,10 @@ patchDefinitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -62039,7 +54401,8 @@ patchDefinitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -62058,24 +54421,27 @@ patchDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO l-interface( logical-link Source l-interface, ONE2MANY)(4) + - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link IsA model-ver, Many2One) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also + -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -62086,6 +54452,7 @@ patchDefinitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -62121,11 +54488,13 @@ patchDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -62138,13 +54507,15 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -62176,9 +54547,11 @@ patchDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -62201,14 +54574,16 @@ patchDefinitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -62234,18 +54609,21 @@ patchDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM allotted-resource( allotted-resource IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf IsA model-ver, Many2One) + - FROM l3-network( l3-network IsA model-ver, Many2One) + - FROM logical-link( logical-link IsA model-ver, Many2One) + - FROM service-instance( service-instance IsA model-ver, Many2One) + - FROM vf-module( vf-module IsA model-ver, Many2One) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -62283,7 +54661,8 @@ patchDefinitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -62316,10 +54695,11 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -62339,13 +54719,15 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -62452,8 +54834,9 @@ patchDefinitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -62470,7 +54853,8 @@ patchDefinitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -62492,8 +54876,9 @@ patchDefinitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -62534,6 +54919,12 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -62589,9 +54980,10 @@ patchDefinitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -62626,8 +55018,9 @@ patchDefinitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -62706,7 +55099,8 @@ patchDefinitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -62721,17 +55115,19 @@ patchDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -62778,7 +55174,9 @@ patchDefinitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -62829,7 +55227,8 @@ patchDefinitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -62848,17 +55247,18 @@ patchDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration AppliesTo pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -62898,6 +55298,7 @@ patchDefinitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -62934,9 +55335,11 @@ patchDefinitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -62963,7 +55366,8 @@ patchDefinitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -62990,7 +55394,9 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -63015,19 +55421,20 @@ patchDefinitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -63097,6 +55504,7 @@ patchDefinitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. pservers: description: | Collection of compute hosts. @@ -63119,7 +55527,9 @@ patchDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -63222,7 +55632,8 @@ patchDefinitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -63245,7 +55656,9 @@ patchDefinitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -63267,9 +55680,11 @@ patchDefinitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -63339,7 +55754,9 @@ patchDefinitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -63382,9 +55799,11 @@ patchDefinitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -63423,37 +55842,34 @@ patchDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance IsA model-ver, Many2One) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -63530,10 +55946,12 @@ patchDefinitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -63562,9 +55980,11 @@ patchDefinitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -63590,9 +56010,10 @@ patchDefinitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -63619,8 +56040,9 @@ patchDefinitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -63666,8 +56088,10 @@ patchDefinitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -63686,8 +56110,10 @@ patchDefinitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -63744,14 +56170,17 @@ patchDefinitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -63782,6 +56211,7 @@ patchDefinitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -63810,13 +56240,15 @@ patchDefinitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -63842,7 +56274,9 @@ patchDefinitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id properties: @@ -63897,14 +56331,15 @@ patchDefinitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -63970,13 +56405,16 @@ patchDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + - TO model-ver( vf-module IsA model-ver, Many2One) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -63995,6 +56433,7 @@ patchDefinitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module vf-modules: description: | Collection of vf-modules, a deployment unit of VNFCs @@ -64007,7 +56446,9 @@ patchDefinitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -64030,10 +56471,11 @@ patchDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -64059,10 +56501,11 @@ patchDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -64088,9 +56531,10 @@ patchDefinitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -64113,15 +56557,17 @@ patchDefinitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -64157,8 +56603,10 @@ patchDefinitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -64190,15 +56638,17 @@ patchDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -64226,8 +56676,10 @@ patchDefinitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -64249,7 +56701,9 @@ patchDefinitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -64264,11 +56718,12 @@ patchDefinitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -64315,11 +56770,12 @@ patchDefinitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -64350,12 +56806,14 @@ patchDefinitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -64391,19 +56849,20 @@ patchDefinitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -64428,8 +56887,10 @@ patchDefinitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node vservers: description: | Collection of virtual Servers, aka virtual machines or VMs. @@ -64442,11 +56903,12 @@ patchDefinitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name @@ -64477,12 +56939,6 @@ patchDefinitions: items: $ref: "#/patchDefinitions/zone" getDefinitions: - aai-internal: - properties: - property-name: - type: string - property-value: - type: string action: properties: action-type: @@ -64511,21 +56967,24 @@ getDefinitions: description: | Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE) - - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( allotted-resource IsA model-ver, Many2One) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - id properties: @@ -64582,15 +57041,18 @@ getDefinitions: description: | Availability zone, a collection of compute hosts/pservers ###### Related Nodes - - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: - availability-zone-name - hypervisor-type @@ -64658,7 +57120,9 @@ getDefinitions: class-of-service: description: | ###### Related Nodes - - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also required: - cos properties: @@ -64718,27 +57182,29 @@ getDefinitions: description: | cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many) - - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2) + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - cloud-owner - cloud-region-id @@ -64770,6 +57236,7 @@ getDefinitions: description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. @@ -64842,20 +57309,22 @@ getDefinitions: description: | Collection of physical locations that can house cloud-regions. ###### Related Nodes - - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE - - COMPLEX is DELETED when these are DELETED CTAG-POOL + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -64925,19 +57394,21 @@ getDefinitions: description: | Port Mirror Configuration. ###### Related Nodes - - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) - - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) - - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC - - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - TO l-interface( configuration AppliesTo l-interface, ONE2MANY) + - TO pnf( configuration AppliesTo pnf, ONE2MANY) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) + - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) + - FROM evc( evc BelongsTo configuration, ONE2ONE)(1) + - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - configuration-id - configuration-type @@ -65017,10 +57488,11 @@ getDefinitions: description: | Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - CONNECTOR is DELETED when these are DELETED METADATUM + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also required: - resource-instance-id properties: @@ -65065,10 +57537,12 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also required: - constrained-element-set-uuid - constraint-type @@ -65099,8 +57573,10 @@ getDefinitions: ctag-assignment: description: | ###### Related Nodes - - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also required: - vlan-id-inner properties: @@ -65125,10 +57601,12 @@ getDefinitions: description: | A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) - - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also required: - target-pe - availability-zone-name @@ -65163,8 +57641,9 @@ getDefinitions: description: | customer identifiers to provide linkage back to BSS information. ###### Related Nodes - - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also required: - global-customer-id - subscriber-name @@ -65223,8 +57702,9 @@ getDefinitions: description: | Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + required: - switch-name - vcenter-url @@ -65300,9 +57780,11 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also required: - element-choice-set-uuid - element-choice-set-name @@ -65333,8 +57815,10 @@ getDefinitions: description: | Metadata for entitlement group. ###### Related Nodes - - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also required: - group-uuid - resource-uuid @@ -65364,8 +57848,9 @@ getDefinitions: description: | Persist EMS address information used by EMS driver. ###### Related Nodes - - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) - - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2) + + -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also required: - ems-id properties: @@ -65391,10 +57876,12 @@ getDefinitions: description: | Persist common address information of external systems. ###### Related Nodes - - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) - - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) - - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) - - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3) + + -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also required: - esr-system-info-id - user-name @@ -65476,9 +57963,10 @@ getDefinitions: description: | Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2) - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) - - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + + -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also required: - thirdparty-sdnc-id properties: @@ -65510,8 +57998,9 @@ getDefinitions: description: | Persist VNFM address information used by VF-C. ###### Related Nodes - - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) - - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2) + + -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also required: - vnfm-id properties: @@ -65543,7 +58032,9 @@ getDefinitions: description: | evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - evc-id properties: @@ -65633,10 +58124,12 @@ getDefinitions: description: | Openstack flavor. ###### Related Nodes - - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER + required: - flavor-id - flavor-name @@ -65700,12 +58193,14 @@ getDefinitions: description: | Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - sequence properties: @@ -65727,7 +58222,9 @@ getDefinitions: description: | forwarder object is an optional child object of the Configuration object. ###### Related Nodes - - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also required: - forwarder-evc-id properties: @@ -65769,11 +58266,13 @@ getDefinitions: description: | Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) - - FORWARDING-PATH is DELETED when these are DELETED FORWARDER - - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also required: - forwarding-path-id - forwarding-path-name @@ -65808,44 +58307,41 @@ getDefinitions: description: | General purpose VNF ###### Related Nodes - - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) - - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) - - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE - - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( generic-vnf IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - vnf-id - - vnf-instance-id - vnf-name - vnf-type - - vnf-package-name - - vnf-discriptor-name - - job-id - in-maint - is-closed-loop-disabled properties: @@ -65949,8 +58445,10 @@ getDefinitions: description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -66061,9 +58559,10 @@ getDefinitions: description: | Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -66099,7 +58598,9 @@ getDefinitions: host-route: description: | ###### Related Nodes - - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - host-route-id - route-prefix @@ -66142,10 +58643,11 @@ getDefinitions: description: | Represents a HPA capability ###### Related Nodes - - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) - - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also required: - hpa-capability-id - hpa-feature @@ -66177,7 +58679,9 @@ getDefinitions: description: | HPA Capability Feature attributes ###### Related Nodes - - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - hpa-attribute-key properties: @@ -66198,11 +58702,13 @@ getDefinitions: description: | Openstack image. ###### Related Nodes - - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - IMAGE cannot be deleted if linked to VSERVER - - IMAGE is DELETED when these are DELETED METADATUM + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -66275,22 +58781,20 @@ getDefinitions: description: | General mechanism for grouping instances ###### Related Nodes - - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - instance-group-role - - model-invariant-id - - model-version-id - id - description - type @@ -66354,13 +58858,9 @@ getDefinitions: network: type: object $ref: "#/getDefinitions/network" - aai-internal: - type: object - $ref: "#/getDefinitions/aai-internal" nodes: - type: array - items: - $ref: "#/getDefinitions/aai-internal" + type: object + $ref: "#/getDefinitions/nodes" inventory-item: properties: inventory-item-type: @@ -66405,9 +58905,10 @@ getDefinitions: description: | IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) - - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) - - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - ipsec-configuration-id properties: @@ -66501,26 +59002,28 @@ getDefinitions: description: | Logical interfaces, e.g., a vnic. ###### Related Nodes - - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN - - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1) + - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM configuration( configuration AppliesTo l-interface, ONE2MANY) + - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - interface-name - is-port-mirrored @@ -66556,16 +59059,19 @@ getDefinitions: description: Human friendly text regarding this interface. is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. @@ -66605,12 +59111,14 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - l3-interface-ipv4-address properties: @@ -66649,12 +59157,14 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY) - - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) - - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - l3-interface-ipv6-address properties: @@ -66693,24 +59203,25 @@ getDefinitions: description: | Generic network definition ###### Related Nodes - - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) - - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) - - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) - - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - TO model-ver( l3-network IsA model-ver, Many2One) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - network-id - network-name @@ -66739,6 +59250,7 @@ getDefinitions: description: Neutron network id of this Interface is-bound-to-vpn: type: boolean + description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED @@ -66784,10 +59296,13 @@ getDefinitions: description: Name associated with the physical network. is-provider-network: type: boolean + description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean + description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean + description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. @@ -66821,17 +59336,19 @@ getDefinitions: description: | Link aggregate interface ###### Related Nodes - - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) - - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE - - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -66862,6 +59379,7 @@ getDefinitions: description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: @@ -66882,8 +59400,10 @@ getDefinitions: description: | LAG links can connect lag-interfaces ###### Related Nodes - - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - link-name properties: @@ -66909,8 +59429,10 @@ getDefinitions: description: | Metadata for license group. ###### Related Nodes - - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - group-uuid - resource-uuid @@ -66940,7 +59462,8 @@ getDefinitions: description: | describes a line-of-business ###### Related Nodes - - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - line-of-business-name properties: @@ -66966,24 +59489,27 @@ getDefinitions: description: | Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY) - - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY) - - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) - - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) - - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) - - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) - - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO l-interface( logical-link Source l-interface, ONE2MANY)(4) + - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4) + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - TO model-ver( logical-link IsA model-ver, Many2One) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also + -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also required: - link-name - in-maint @@ -66994,6 +59520,7 @@ getDefinitions: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. link-type: type: string description: Type of logical link, e.g., evc @@ -67072,11 +59599,13 @@ getDefinitions: description: | Key/value pairs ###### Related Nodes - - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) - - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) - - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) - - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also required: - metaname - metaval @@ -67092,13 +59621,15 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) - - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT - - MODEL is DELETED when these are DELETED MODEL-VER + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + required: - model-invariant-id - model-type @@ -67141,9 +59672,11 @@ getDefinitions: description: | This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) - - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -67169,14 +59702,16 @@ getDefinitions: description: | Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) - - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) - - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - model-element-uuid - new-data-del-flag @@ -67219,18 +59754,21 @@ getDefinitions: description: | Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT - - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM allotted-resource( allotted-resource IsA model-ver, Many2One) + - FROM generic-vnf( generic-vnf IsA model-ver, Many2One) + - FROM l3-network( l3-network IsA model-ver, Many2One) + - FROM logical-link( logical-link IsA model-ver, Many2One) + - FROM service-instance( service-instance IsA model-ver, Many2One) + - FROM vf-module( vf-module IsA model-ver, Many2One) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - model-version-id - model-name @@ -67283,7 +59821,8 @@ getDefinitions: multicast-configuration: description: | ###### Related Nodes - - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - multicast-configuration-id - multicast-protocol @@ -67323,10 +59862,11 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - named-query-uuid - named-query-name @@ -67356,13 +59896,15 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) - - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) - - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) - - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also required: - named-query-element-uuid properties: @@ -67491,8 +60033,9 @@ getDefinitions: network-policy: description: | ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - network-policy-id properties: @@ -67516,7 +60059,8 @@ getDefinitions: description: | Network profile populated by SDN-GP for SNMP ###### Related Nodes - - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + required: - nm-profile-name properties: @@ -67545,8 +60089,9 @@ getDefinitions: description: | This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) - - NEWVCE is DELETED when these are DELETED L-INTERFACE + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - vnf-id2 - vnf-name @@ -67610,6 +60155,12 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" notification-event: properties: cambria.partition: @@ -67665,9 +60216,10 @@ getDefinitions: description: | OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) - - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - network-uuid - network-name @@ -67709,8 +60261,9 @@ getDefinitions: description: | It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) - - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - operational-environment-id - operational-environment-name @@ -67805,7 +60358,8 @@ getDefinitions: description: | describes an owning-entity ###### Related Nodes - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - owning-entity-id - owning-entity-name @@ -67827,17 +60381,19 @@ getDefinitions: description: | Physical interface (e.g., nic) ###### Related Nodes - - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) - - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) - - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) - - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) - - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF - - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - interface-name - in-maint @@ -67877,6 +60433,7 @@ getDefinitions: description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status @@ -67904,7 +60461,9 @@ getDefinitions: description: | Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - link-name properties: @@ -67962,7 +60521,8 @@ getDefinitions: description: | describes a platform ###### Related Nodes - - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - platform-name properties: @@ -67988,17 +60548,18 @@ getDefinitions: description: | PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY) - - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + - FROM configuration( configuration AppliesTo pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - pnf-name - in-maint @@ -68038,6 +60599,7 @@ getDefinitions: description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. frame-id: type: string description: ID of the physical frame (relay rack) where pnf is installed. @@ -68095,9 +60657,11 @@ getDefinitions: description: | Used to capture the network interfaces of this VCE ###### Related Nodes - - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) - - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also required: - interface-id - orchestration-status @@ -68153,7 +60717,8 @@ getDefinitions: description: | describes the project ###### Related Nodes - - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - project-name properties: @@ -68187,7 +60752,9 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also required: - property-constraint-uuid - constraint-type @@ -68214,19 +60781,20 @@ getDefinitions: description: | Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) - - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) - - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) - - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) - - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER - - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE - - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - hostname - in-maint @@ -68296,6 +60864,7 @@ getDefinitions: description: internet topology of Pserver in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -68348,7 +60917,9 @@ getDefinitions: description: | TBD ###### Related Nodes - - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - related-lookup-uuid - source-node-type @@ -68463,7 +61034,8 @@ getDefinitions: description: | Openstack route table reference. ###### Related Nodes - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + required: - route-table-reference-id - route-table-reference-fqdn @@ -68493,7 +61065,9 @@ getDefinitions: description: | Route target information ###### Related Nodes - - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - global-route-target - route-target-role @@ -68522,9 +61096,11 @@ getDefinitions: routing-instance: description: | ###### Related Nodes - - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - routing-instance-id properties: @@ -68605,7 +61181,9 @@ getDefinitions: description: | Openstack segmentation assignment. ###### Related Nodes - - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also required: - segmentation-id properties: @@ -68665,9 +61243,11 @@ getDefinitions: description: | Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) - - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - service-type - vnf-type @@ -68713,37 +61293,34 @@ getDefinitions: description: | Instance of a service ###### Related Nodes - - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) - - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) - - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) - - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) - - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) - - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) - - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) - - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) - - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) - - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) - - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One) - - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) - - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) - - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH - - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - TO model-ver( service-instance IsA model-ver, Many2One) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - service-instance-id - - service-type - - service-role - - created-at - - updated-at - - description properties: service-instance-id: type: string @@ -68841,10 +61418,12 @@ getDefinitions: description: | Object that group service instances. ###### Related Nodes - - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) - - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) - - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - service-type properties: @@ -68884,9 +61463,11 @@ getDefinitions: site-pair: description: | ###### Related Nodes - - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) - - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) - - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - site-pair-id properties: @@ -68923,9 +61504,10 @@ getDefinitions: description: | Set of instances for probes used to measure service level agreements ###### Related Nodes - - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) - - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) - - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - site-pair-set-id properties: @@ -68963,8 +61545,9 @@ getDefinitions: description: | Openstack snapshot ###### Related Nodes - - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - snapshot-id properties: @@ -69017,8 +61600,10 @@ getDefinitions: description: | SR-IOV Physical Function ###### Related Nodes - - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) - - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - pf-pci-id properties: @@ -69044,8 +61629,10 @@ getDefinitions: description: | SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) - - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - pci-id properties: @@ -69112,14 +61699,17 @@ getDefinitions: subnet: description: | ###### Related Nodes - - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) - - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) - - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST - - SUBNET is DELETED when these are DELETED HOST-ROUTE + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + required: - subnet-id - dhcp-enabled @@ -69150,6 +61740,7 @@ getDefinitions: description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean + description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp @@ -69193,13 +61784,15 @@ getDefinitions: description: | Openstack tenant ###### Related Nodes - - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) - - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) - - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) - - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TENANT cannot be deleted if linked to VSERVER + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + required: - tenant-id - tenant-name @@ -69236,7 +61829,9 @@ getDefinitions: description: | Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - id properties: @@ -69298,14 +61893,15 @@ getDefinitions: description: | Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) - - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) - - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) - - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - vnf-id - vnf-name @@ -69396,13 +61992,16 @@ getDefinitions: description: | a deployment unit of VNFCs ###### Related Nodes - - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) - - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One) - - VF-MODULE cannot be deleted if linked to VNFC + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + - TO model-ver( vf-module IsA model-ver, Many2One) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - vf-module-id - is-base-vf-module @@ -69421,6 +62020,7 @@ getDefinitions: description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean + description: used to indicate whether or not this object is base vf module resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -69468,7 +62068,9 @@ getDefinitions: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -69498,10 +62100,11 @@ getDefinitions: description: | IPv4 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - vip-ipv4-address properties: @@ -69540,10 +62143,11 @@ getDefinitions: description: | IPv6 Address Range ###### Related Nodes - - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) - - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - vip-ipv6-address properties: @@ -69582,9 +62186,10 @@ getDefinitions: description: | Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + required: - vdc-id - vdc-name @@ -69614,15 +62219,17 @@ getDefinitions: description: | Definition of vlan ###### Related Nodes - - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) - - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) - - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) - - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) - - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST - - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - vlan-interface - in-maint @@ -69662,11 +62269,13 @@ getDefinitions: description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. relationship-list: type: array items: @@ -69698,8 +62307,10 @@ getDefinitions: description: | Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) - - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + required: - vnf-image-uuid - application @@ -69738,15 +62349,17 @@ getDefinitions: vnfc: description: | ###### Related Nodes - - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) - - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) - - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) - - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY) - - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) - - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE) - - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - vnfc-name - nfc-naming-code @@ -69774,8 +62387,10 @@ getDefinitions: description: Oam V4 vip address of this vnfc in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC @@ -69812,7 +62427,9 @@ getDefinitions: description: | Ephemeral Block storage volume. ###### Related Nodes - - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also required: - volume-id - volume-selflink @@ -69834,11 +62451,12 @@ getDefinitions: description: | Persistent block-level storage. ###### Related Nodes - - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) - - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) - - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + required: - volume-group-id - volume-group-name @@ -69892,11 +62510,12 @@ getDefinitions: description: | VPLS Provider Edge routers. ###### Related Nodes - - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) - - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) - - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also required: - equipment-name properties: @@ -69942,12 +62561,14 @@ getDefinitions: description: | VPN binding ###### Related Nodes - - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY) - - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) - - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) - - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK - - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + required: - vpn-id - vpn-name @@ -69995,19 +62616,20 @@ getDefinitions: description: | Virtual Servers, aka virtual machine or VM. ###### Related Nodes - - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) - - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) - - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) - - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) - - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) - - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) - - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) - - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) - - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) - - VSERVER is DELETED when these are DELETED L-INTERFACE - - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - vserver-id - vserver-name @@ -70032,8 +62654,10 @@ getDefinitions: description: URL to endpoint where AAI can get more details in-maint: type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -70061,11 +62685,12 @@ getDefinitions: description: | A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) - - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) - - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + required: - zone-id - zone-name