Loading src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +110 −12 Original line number Original line Diff line number Diff line Loading @@ -489,11 +489,18 @@ definitions: NOTE: Either a "nsPaasServiceRequestId" or a "vnfPaasServiceRequestId" shall NOTE: Either a "nsPaasServiceRequestId" or a "vnfPaasServiceRequestId" shall be provided, but not both. be provided, but not both. type: object type: object required: oneOf: - id - required: - paasServiceId - paasServiceId - paasServiceType - paasServiceType - paasServiceHandle - paasServiceHandle - nsPaasServiceRequestId - required: - paasServiceId - paasServiceType - paasServiceHandle - vnfPaasServiceRequestId properties: properties: id: id: description: > description: > Loading @@ -519,12 +526,12 @@ definitions: description: > description: > Identifier of the PaaS Service request in the NSD that Identifier of the PaaS Service request in the NSD that maps to the assigned PaaS Service. See note maps to the assigned PaaS Service. See note $ref: "#/definitions/IdentifierInNsd" $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfPaasServiceRequestId: vnfPaasServiceRequestId: description: > description: > Identifier of the PaaS Service request in the VNFD Identifier of the PaaS Service request in the VNFD that maps to the assigned PaaS Service. See note. that maps to the assigned PaaS Service. See note. $ref: "#/definitions/IdentifierInVnfd" $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" paasServiceHandle: paasServiceHandle: description: > description: > A handle enabling the access and use of the PaaS A handle enabling the access and use of the PaaS Loading Loading @@ -874,7 +881,7 @@ definitions: the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD. be kept in sync with the values in the VNFD. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters applicable NOTE 3: These attributes are sometimes also referred to as configuration parameters applicable to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, some are set prior to instantiation (are part of initial configuration) and can be modified later, some are set prior to instantiation (are part of initial configuration) and can be modified later, and others can be set only after instantiation. The applicability of certain configuration may depend and others can be set only after instantiation. The applicability of certain configuration may depend Loading @@ -885,6 +892,10 @@ definitions: multi-site VL instance (refer to clause 6.5.3.59). multi-site VL instance (refer to clause 6.5.3.59). NOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not NOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant. be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant. NOTE 6: The scale level indicated in “scaleStatus” for a scaling aspect that has not been deployed due to the selection of deployable modules will be used to instantiate the related VNFCs if a VNF LCM operation changes the selected deployable modules and the related VNFCs are instantiated, unless the VNF LCM operation explicitly indicates the scale level for the aspect. type: object type: object required: required: - id - id Loading Loading @@ -977,6 +988,17 @@ definitions: In addition, the provisions in clause 6.7 shall apply. In addition, the provisions in clause 6.7 shall apply. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateInfo: description: > Information about certificate and certificate management in this VNF. Shall be present when using delegation mode, otherwise shall be absent. This attribute can be modified with the PATCH method. Content of this attribute shall not be either added (if previously not set) or removed (if previously set) by using the "ModifyVnfInfoData" structure. Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure. See note 3 $ref: "#/definitions/CertificateInfo" vimId: vimId: description: > description: > Identifier of a VIM that manages resources for the VNF instance. Identifier of a VIM that manages resources for the VNF instance. Loading Loading @@ -1012,8 +1034,14 @@ definitions: $ref: "#/definitions/VnfOperationalStateType" $ref: "#/definitions/VnfOperationalStateType" scaleStatus: scaleStatus: description: > description: > Scale status of the VNF, one entry per aspect. Represents for every Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. the VNF has been scaled w.r.t. that aspect. This attribute shall be present if the VNF supports scaling. For an aspect that has not been deployed because it consists of VDUs that belong to a deployable module that has not been selected (or to multiple deployable modules, none of which have been selected), it indicates the scale level that has been requested in the instantiation or in a scaling operation, or, if none has been requested in any of them, the scale level applicable to the aspect based on the default instantiation level. See note 6. See clause B.2 of ETSI GS NFV-SOL 003 for an explanation of VNF scaling. type: array type: array items: items: $ref: "#/definitions/VnfScaleInfo" $ref: "#/definitions/VnfScaleInfo" Loading @@ -1026,6 +1054,15 @@ definitions: type: array type: array items: items: $ref: "#/definitions/VnfScaleInfo" $ref: "#/definitions/VnfScaleInfo" selectedDeployableModule: description: > References a currently selected deployable module, as defined in the VNFD, that has already completed the instantiation of its VNFCs. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" extCpInfo: extCpInfo: description: > description: > Information about the external CPs exposed by the VNF instance. Information about the external CPs exposed by the VNF instance. Loading Loading @@ -1111,6 +1148,12 @@ definitions: type: array type: array items: items: $ref: "#/definitions/McioInfo" $ref: "#/definitions/McioInfo" vnfPaasServiceInfo: description: > Information on the PaaS Services assigned and used by the VNF instance. type: array items: $ref: "#/definitions/PaasServiceInfo" metadata: metadata: description: > description: > Additional VNF-specific attributes that provide Additional VNF-specific attributes that provide Loading Loading @@ -1145,10 +1188,14 @@ definitions: VirtualCpInfo: VirtualCpInfo: description: 'This type represents the information related to a virtual CP instance of a VNF. description: > NOTE: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing 'This type represents the information related to a virtual CP instance of a VNF. NOTE 1: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the service accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the "InstantiatedVnfInfo" and filtering by corresponding "vduId" values.' the "InstantiatedVnfInfo" and filtering by corresponding "vduId" values.' NOTE 2: The information can be omitted because it is already available as part of the external CP information in the VnfExtCpInfo structure type: object type: object required: required: - cpInstanceId - cpInstanceId Loading @@ -1175,6 +1222,8 @@ definitions: cpProtocolInfo: cpProtocolInfo: description: > description: > Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported. Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported. This attribute may be omitted if the virtual CP is exposed as an external CP. See note 2 type: array type: array items: items: $ref: "#/definitions/CpProtocolInfo" $ref: "#/definitions/CpProtocolInfo" Loading Loading @@ -1323,6 +1372,16 @@ definitions: Additional information which is specific to the MCIO, its type, and which is available from the CISM. Additional information which is specific to the MCIO, its type, and which is available from the CISM. See note 2. See note 2. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateContentId: description: > The identifier of certificate that this MCIO instance uses. Shall be present when using in delegation- mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" LccnLinks: LccnLinks: type: object type: object required: required: Loading Loading @@ -1848,6 +1907,14 @@ definitions: Shall be present in case this CP instance maps to an internal VL (including Shall be present in case this CP instance maps to an internal VL (including externally-managed internal VL). See note 1. externally-managed internal VL). See note 1. $ref: "#/definitions/IdentifierInVnf" $ref: "#/definitions/IdentifierInVnf" certificateContentId: description: > The identifier of certificate that this VNF CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" CpGroupInfo: CpGroupInfo: description: > description: > Loading Loading @@ -2575,10 +2642,41 @@ definitions: description: > description: > Metadata about this CP. Metadata about this CP. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateContentId: description: > The identifier of certificate that this VNFC CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" metadata: metadata: description: > description: > Metadata about this resource. Metadata about this resource. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" trunkPortsInfo: description: > Collections of CPs of the VNFC instance in trunk(s). Shall be present when the VNFC has CPs working in trunk mode, as parent port of a trunk, and other CPs working as subports of the same trunk, and the referred CP instances are also present in the vnfcCpInfo attribute type: array items: #$ref: "#/definitions/TrunkPortsInfo" type: object certificateContentId: description: > The identifier of certificate that this VNFC instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" VnfVirtualLinkResourceInfo: VnfVirtualLinkResourceInfo: description: > description: > Loading Loading
src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +110 −12 Original line number Original line Diff line number Diff line Loading @@ -489,11 +489,18 @@ definitions: NOTE: Either a "nsPaasServiceRequestId" or a "vnfPaasServiceRequestId" shall NOTE: Either a "nsPaasServiceRequestId" or a "vnfPaasServiceRequestId" shall be provided, but not both. be provided, but not both. type: object type: object required: oneOf: - id - required: - paasServiceId - paasServiceId - paasServiceType - paasServiceType - paasServiceHandle - paasServiceHandle - nsPaasServiceRequestId - required: - paasServiceId - paasServiceType - paasServiceHandle - vnfPaasServiceRequestId properties: properties: id: id: description: > description: > Loading @@ -519,12 +526,12 @@ definitions: description: > description: > Identifier of the PaaS Service request in the NSD that Identifier of the PaaS Service request in the NSD that maps to the assigned PaaS Service. See note maps to the assigned PaaS Service. See note $ref: "#/definitions/IdentifierInNsd" $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfPaasServiceRequestId: vnfPaasServiceRequestId: description: > description: > Identifier of the PaaS Service request in the VNFD Identifier of the PaaS Service request in the VNFD that maps to the assigned PaaS Service. See note. that maps to the assigned PaaS Service. See note. $ref: "#/definitions/IdentifierInVnfd" $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" paasServiceHandle: paasServiceHandle: description: > description: > A handle enabling the access and use of the PaaS A handle enabling the access and use of the PaaS Loading Loading @@ -874,7 +881,7 @@ definitions: the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall be kept in sync with the values in the VNFD. be kept in sync with the values in the VNFD. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters applicable NOTE 3: These attributes are sometimes also referred to as configuration parameters applicable to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, some are set prior to instantiation (are part of initial configuration) and can be modified later, some are set prior to instantiation (are part of initial configuration) and can be modified later, and others can be set only after instantiation. The applicability of certain configuration may depend and others can be set only after instantiation. The applicability of certain configuration may depend Loading @@ -885,6 +892,10 @@ definitions: multi-site VL instance (refer to clause 6.5.3.59). multi-site VL instance (refer to clause 6.5.3.59). NOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not NOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant. be listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant. NOTE 6: The scale level indicated in “scaleStatus” for a scaling aspect that has not been deployed due to the selection of deployable modules will be used to instantiate the related VNFCs if a VNF LCM operation changes the selected deployable modules and the related VNFCs are instantiated, unless the VNF LCM operation explicitly indicates the scale level for the aspect. type: object type: object required: required: - id - id Loading Loading @@ -977,6 +988,17 @@ definitions: In addition, the provisions in clause 6.7 shall apply. In addition, the provisions in clause 6.7 shall apply. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateInfo: description: > Information about certificate and certificate management in this VNF. Shall be present when using delegation mode, otherwise shall be absent. This attribute can be modified with the PATCH method. Content of this attribute shall not be either added (if previously not set) or removed (if previously set) by using the "ModifyVnfInfoData" structure. Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure. See note 3 $ref: "#/definitions/CertificateInfo" vimId: vimId: description: > description: > Identifier of a VIM that manages resources for the VNF instance. Identifier of a VIM that manages resources for the VNF instance. Loading Loading @@ -1012,8 +1034,14 @@ definitions: $ref: "#/definitions/VnfOperationalStateType" $ref: "#/definitions/VnfOperationalStateType" scaleStatus: scaleStatus: description: > description: > Scale status of the VNF, one entry per aspect. Represents for every Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. the VNF has been scaled w.r.t. that aspect. This attribute shall be present if the VNF supports scaling. For an aspect that has not been deployed because it consists of VDUs that belong to a deployable module that has not been selected (or to multiple deployable modules, none of which have been selected), it indicates the scale level that has been requested in the instantiation or in a scaling operation, or, if none has been requested in any of them, the scale level applicable to the aspect based on the default instantiation level. See note 6. See clause B.2 of ETSI GS NFV-SOL 003 for an explanation of VNF scaling. type: array type: array items: items: $ref: "#/definitions/VnfScaleInfo" $ref: "#/definitions/VnfScaleInfo" Loading @@ -1026,6 +1054,15 @@ definitions: type: array type: array items: items: $ref: "#/definitions/VnfScaleInfo" $ref: "#/definitions/VnfScaleInfo" selectedDeployableModule: description: > References a currently selected deployable module, as defined in the VNFD, that has already completed the instantiation of its VNFCs. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" extCpInfo: extCpInfo: description: > description: > Information about the external CPs exposed by the VNF instance. Information about the external CPs exposed by the VNF instance. Loading Loading @@ -1111,6 +1148,12 @@ definitions: type: array type: array items: items: $ref: "#/definitions/McioInfo" $ref: "#/definitions/McioInfo" vnfPaasServiceInfo: description: > Information on the PaaS Services assigned and used by the VNF instance. type: array items: $ref: "#/definitions/PaasServiceInfo" metadata: metadata: description: > description: > Additional VNF-specific attributes that provide Additional VNF-specific attributes that provide Loading Loading @@ -1145,10 +1188,14 @@ definitions: VirtualCpInfo: VirtualCpInfo: description: 'This type represents the information related to a virtual CP instance of a VNF. description: > NOTE: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing 'This type represents the information related to a virtual CP instance of a VNF. NOTE 1: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the service accessible via the virtual CP instance by querying the "vnfcResourceInfo" from the "InstantiatedVnfInfo" and filtering by corresponding "vduId" values.' the "InstantiatedVnfInfo" and filtering by corresponding "vduId" values.' NOTE 2: The information can be omitted because it is already available as part of the external CP information in the VnfExtCpInfo structure type: object type: object required: required: - cpInstanceId - cpInstanceId Loading @@ -1175,6 +1222,8 @@ definitions: cpProtocolInfo: cpProtocolInfo: description: > description: > Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported. Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported. This attribute may be omitted if the virtual CP is exposed as an external CP. See note 2 type: array type: array items: items: $ref: "#/definitions/CpProtocolInfo" $ref: "#/definitions/CpProtocolInfo" Loading Loading @@ -1323,6 +1372,16 @@ definitions: Additional information which is specific to the MCIO, its type, and which is available from the CISM. Additional information which is specific to the MCIO, its type, and which is available from the CISM. See note 2. See note 2. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateContentId: description: > The identifier of certificate that this MCIO instance uses. Shall be present when using in delegation- mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" LccnLinks: LccnLinks: type: object type: object required: required: Loading Loading @@ -1848,6 +1907,14 @@ definitions: Shall be present in case this CP instance maps to an internal VL (including Shall be present in case this CP instance maps to an internal VL (including externally-managed internal VL). See note 1. externally-managed internal VL). See note 1. $ref: "#/definitions/IdentifierInVnf" $ref: "#/definitions/IdentifierInVnf" certificateContentId: description: > The identifier of certificate that this VNF CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" CpGroupInfo: CpGroupInfo: description: > description: > Loading Loading @@ -2575,10 +2642,41 @@ definitions: description: > description: > Metadata about this CP. Metadata about this CP. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" certificateContentId: description: > The identifier of certificate that this VNFC CP instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" metadata: metadata: description: > description: > Metadata about this resource. Metadata about this resource. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" trunkPortsInfo: description: > Collections of CPs of the VNFC instance in trunk(s). Shall be present when the VNFC has CPs working in trunk mode, as parent port of a trunk, and other CPs working as subports of the same trunk, and the referred CP instances are also present in the vnfcCpInfo attribute type: array items: #$ref: "#/definitions/TrunkPortsInfo" type: object certificateContentId: description: > The identifier of certificate that this VNFC instance uses. Shall be present when using in delegation-mode. Otherwise shall not be present. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" VnfVirtualLinkResourceInfo: VnfVirtualLinkResourceInfo: description: > description: > Loading