Loading src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +15 −4 Original line number Diff line number Diff line Loading @@ -2,7 +2,7 @@ swagger: "2.0" info: version: "1.1.0" title: "SOL002 - VNF Configuration interface" title: "SOL002 - VNF Lifecycle Management Interface" description: > VNF Configuration interface of ETSI NFV SOL002 Loading @@ -21,7 +21,7 @@ externalDocs: description: ETSI GS NFV-SOL 002 V2.4.1 url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf basePath: /vnfconfig/v1 basePath: /vnflcm/v1 schemes: - http Loading Loading @@ -256,12 +256,12 @@ paths: managed by the VNFM, and are reflected in the representation of this resource parameters: - name: vnfInfoModifications - name: vnfInfoModificationRequest description: Input parameters for VNF info modification required: true in: body schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications" $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" responses: 202: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location" Loading Loading @@ -1116,6 +1116,17 @@ paths: minimum: 0 schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 303: # description: > # 303 SEE OTHER # A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM # is to not create redundant subscriptions. # The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing # subscription resource. # The response body shall be empty. # schema: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: Loading src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml +31 −29 Original line number Diff line number Diff line Loading @@ -261,6 +261,7 @@ definitions: required: - id - vnfVirtualLinkDescId - networkResource properties: id: description: > Loading @@ -280,7 +281,7 @@ definitions: Link ports of this VL. type: array items: $ref: "#/definitions/VnfLinkPort" $ref: "#/definitions/VnfLinkPortInfo" HealVnfRequest: type: object Loading Loading @@ -347,6 +348,7 @@ definitions: required: - flavourId - vnfState - _links properties: flavourId: description: > Loading @@ -369,7 +371,7 @@ definitions: type: array minItems: 1 items: $ref: "#/definitions/extCpInfo" $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo" extVirtualLinkInfo: description: > Information about the external VLs the VNF instance is connected to. Loading Loading @@ -417,8 +419,11 @@ definitions: items: $ref: "#/definitions/VirtualStorageResourceInfo" vnfcInfo: description: "TBD" type: string description: > Information about the VNFC instances. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo" metadata: description: > Additional VNF-specific metadata describing the VNF instance. Loading Loading @@ -860,7 +865,6 @@ definitions: - id - vduId - computeResource - vnfcCpInfo properties: id: description: > Loading Loading @@ -903,21 +907,32 @@ definitions: description: > Identifier of this VNFC CP instance and the associated array entry. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > When the VNFC CP is exposed as external CP of the VNF, the identifier of this external VNF CP. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" addresses: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpProtocolInfo: description: > List of network addresses that have been configured (statically or dynamically) on the CP. $ref: "#/definitions/NetworkAddressInfo" Network protocol information for this CP. type: array items: $ref: "#/definitions/CpProtocolInfo" vnfLinkPortId: description: > Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" metadata: description: > Metadata about this CP. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > Metadata about this resource. Loading Loading @@ -1006,7 +1021,7 @@ definitions: - vnfProductName - vnfSoftwareVersion - vnfdVersion - onboardedVnfPkgInfoId - vnfPkgInfoId - instantiationState properties: id: Loading Loading @@ -1043,7 +1058,7 @@ definitions: description: > Identifies the version of the VNFD. The value is copied from the VNFD. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" onboardedVnfPkgInfoId: vnfPkgId: description: > Identifier of information held by the NFVO about the specific VNF package on which the VNF is based. This identifier was allocated by the Loading @@ -1066,19 +1081,6 @@ definitions: shall be present if the instantiateState attribute value is INSTANTIATED. $ref: "#/definitions/InstantiatedVnfInfo" vnfInstanceIds: description: > If present, match VNF instances with an instance identifier listed in this attribute. The attributes "vnfInstanceIds" and "vnfInstanceNames" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstanceNames: description: > If present, match VNF instances with a VNF Instance Name listed in Loading Loading @@ -1279,7 +1281,7 @@ definitions: currently allowed. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" VnfLinkPort: VnfLinkPortInfo: type: object required: - id Loading Loading @@ -1351,7 +1353,7 @@ definitions: May be present otherwise. type: array items: $ref: "#/definitions/VnfLinkPort" $ref: "#/definitions/VnfLinkPortInfo" metadata: description: > Metadata about this resource. Loading src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml +125 −0 Original line number Diff line number Diff line Loading @@ -882,6 +882,38 @@ definitions: "vnfPkgId” attribute. $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" VnfInfoModificationRequest: description: > This type represents attribute modifications for an "Individual VNF instance" resource, i.e. modifications to a resource representation based on the "VnfInstance" data type. The attributes of "VnfInstance" that can be modified type: object properties: vnfInstanceName: description: > If present, this attribute signals modifications of the "vnfInstanceName" attribute in "VnfInstance". type: string vnfInstanceDescription: description: > If present, this attribute signals modifications of the "vnfInstanceDescription" attribute in "VnfInstance". type: string vnfConfigurableProperties: description: > If present, this attribute signals modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > If present, this attribute signals modifications of the "metadata" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > If present, this attribute signals modifications of the "extensions" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfInstance: description: > This type represents a VNF instance. Loading Loading @@ -1250,3 +1282,96 @@ definitions: Metadata about this resource. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfcInfo: description: > This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1. type: object required: - id - vduId - vnfcResourceInfoId - vnfcState properties: id: description: > Identifier of the VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Reference to the applicable VDU information element in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcResourceInfoId: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcState: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. State of the VNFC instance. Permitted values: • STARTED: The VNFC instance is up and running. • STOPPED: The VNFC instance has been shut down type: string enum: - STARTED - STOPPED $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcConfigurableProperties: description: > Current values of the configurable properties of the VNFC instance. Configurable properties referred in this attribute are declared in the VNFD. This attribute can be modified with the PATCH method $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfExtCpInfo: description: > This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1. type: object required: - id - cpdId - cpProtocolInfo properties: id: description: > Identifier of the external CP instance and the related information instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the external CPD, VnfExtCpd, in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" cpProtocolInfo: description: > Network protocol information for this CP. type: array items: $ref: "#/definitions/CpProtocolInfo" extLinkPortId: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this external CP. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" associatedVnfcCpId: description: > Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents the VNFC CP which is exposed by this external CP instance. Shall be present in case this CP instance maps to a VNFC CP. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL which is exposed by this external CP instance. Shall be present in case this CP instance maps to an internal VL. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" Loading
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +15 −4 Original line number Diff line number Diff line Loading @@ -2,7 +2,7 @@ swagger: "2.0" info: version: "1.1.0" title: "SOL002 - VNF Configuration interface" title: "SOL002 - VNF Lifecycle Management Interface" description: > VNF Configuration interface of ETSI NFV SOL002 Loading @@ -21,7 +21,7 @@ externalDocs: description: ETSI GS NFV-SOL 002 V2.4.1 url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf basePath: /vnfconfig/v1 basePath: /vnflcm/v1 schemes: - http Loading Loading @@ -256,12 +256,12 @@ paths: managed by the VNFM, and are reflected in the representation of this resource parameters: - name: vnfInfoModifications - name: vnfInfoModificationRequest description: Input parameters for VNF info modification required: true in: body schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications" $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" responses: 202: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/202-with-Location" Loading Loading @@ -1116,6 +1116,17 @@ paths: minimum: 0 schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 303: # description: > # 303 SEE OTHER # A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM # is to not create redundant subscriptions. # The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing # subscription resource. # The response body shall be empty. # schema: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: Loading
src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml +31 −29 Original line number Diff line number Diff line Loading @@ -261,6 +261,7 @@ definitions: required: - id - vnfVirtualLinkDescId - networkResource properties: id: description: > Loading @@ -280,7 +281,7 @@ definitions: Link ports of this VL. type: array items: $ref: "#/definitions/VnfLinkPort" $ref: "#/definitions/VnfLinkPortInfo" HealVnfRequest: type: object Loading Loading @@ -347,6 +348,7 @@ definitions: required: - flavourId - vnfState - _links properties: flavourId: description: > Loading @@ -369,7 +371,7 @@ definitions: type: array minItems: 1 items: $ref: "#/definitions/extCpInfo" $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfExtCpInfo" extVirtualLinkInfo: description: > Information about the external VLs the VNF instance is connected to. Loading Loading @@ -417,8 +419,11 @@ definitions: items: $ref: "#/definitions/VirtualStorageResourceInfo" vnfcInfo: description: "TBD" type: string description: > Information about the VNFC instances. type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo" metadata: description: > Additional VNF-specific metadata describing the VNF instance. Loading Loading @@ -860,7 +865,6 @@ definitions: - id - vduId - computeResource - vnfcCpInfo properties: id: description: > Loading Loading @@ -903,21 +907,32 @@ definitions: description: > Identifier of this VNFC CP instance and the associated array entry. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > When the VNFC CP is exposed as external CP of the VNF, the identifier of this external VNF CP. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" addresses: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpProtocolInfo: description: > List of network addresses that have been configured (statically or dynamically) on the CP. $ref: "#/definitions/NetworkAddressInfo" Network protocol information for this CP. type: array items: $ref: "#/definitions/CpProtocolInfo" vnfLinkPortId: description: > Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" metadata: description: > Metadata about this CP. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > Metadata about this resource. Loading Loading @@ -1006,7 +1021,7 @@ definitions: - vnfProductName - vnfSoftwareVersion - vnfdVersion - onboardedVnfPkgInfoId - vnfPkgInfoId - instantiationState properties: id: Loading Loading @@ -1043,7 +1058,7 @@ definitions: description: > Identifies the version of the VNFD. The value is copied from the VNFD. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" onboardedVnfPkgInfoId: vnfPkgId: description: > Identifier of information held by the NFVO about the specific VNF package on which the VNF is based. This identifier was allocated by the Loading @@ -1066,19 +1081,6 @@ definitions: shall be present if the instantiateState attribute value is INSTANTIATED. $ref: "#/definitions/InstantiatedVnfInfo" vnfInstanceIds: description: > If present, match VNF instances with an instance identifier listed in this attribute. The attributes "vnfInstanceIds" and "vnfInstanceNames" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstanceNames: description: > If present, match VNF instances with a VNF Instance Name listed in Loading Loading @@ -1279,7 +1281,7 @@ definitions: currently allowed. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" VnfLinkPort: VnfLinkPortInfo: type: object required: - id Loading Loading @@ -1351,7 +1353,7 @@ definitions: May be present otherwise. type: array items: $ref: "#/definitions/VnfLinkPort" $ref: "#/definitions/VnfLinkPortInfo" metadata: description: > Metadata about this resource. Loading
src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml +125 −0 Original line number Diff line number Diff line Loading @@ -882,6 +882,38 @@ definitions: "vnfPkgId” attribute. $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" VnfInfoModificationRequest: description: > This type represents attribute modifications for an "Individual VNF instance" resource, i.e. modifications to a resource representation based on the "VnfInstance" data type. The attributes of "VnfInstance" that can be modified type: object properties: vnfInstanceName: description: > If present, this attribute signals modifications of the "vnfInstanceName" attribute in "VnfInstance". type: string vnfInstanceDescription: description: > If present, this attribute signals modifications of the "vnfInstanceDescription" attribute in "VnfInstance". type: string vnfConfigurableProperties: description: > If present, this attribute signals modifications of the "vnfConfigurableProperties" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" metadata: description: > If present, this attribute signals modifications of the "metadata" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > If present, this attribute signals modifications of the "extensions" attribute in "VnfInstance". $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfInstance: description: > This type represents a VNF instance. Loading Loading @@ -1250,3 +1282,96 @@ definitions: Metadata about this resource. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfcInfo: description: > This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the provisions defined in table 5.5.3.23-1. type: object required: - id - vduId - vnfcResourceInfoId - vnfcState properties: id: description: > Identifier of the VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Reference to the applicable VDU information element in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcResourceInfoId: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcState: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. State of the VNFC instance. Permitted values: • STARTED: The VNFC instance is up and running. • STOPPED: The VNFC instance has been shut down type: string enum: - STARTED - STOPPED $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcConfigurableProperties: description: > Current values of the configurable properties of the VNFC instance. Configurable properties referred in this attribute are declared in the VNFD. This attribute can be modified with the PATCH method $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" VnfExtCpInfo: description: > This type represents information about an external CP of a VNF. It shall comply with the provisions defined in table 5.5.3.25 1. type: object required: - id - cpdId - cpProtocolInfo properties: id: description: > Identifier of the external CP instance and the related information instance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the external CPD, VnfExtCpd, in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" cpProtocolInfo: description: > Network protocol information for this CP. type: array items: $ref: "#/definitions/CpProtocolInfo" extLinkPortId: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this external CP. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" associatedVnfcCpId: description: > Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that represents the VNFC CP which is exposed by this external CP instance. Shall be present in case this CP instance maps to a VNFC CP. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents the internal VL which is exposed by this external CP instance. Shall be present in case this CP instance maps to an internal VL. See note. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"