Loading src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +73 −38 Original line number Diff line number Diff line Loading @@ -806,6 +806,8 @@ definitions: VnffgInfo: description: > Information on the VNFFG(s) of the NS instance. NOTE: It indicates an exhaustive list of all the CP instances and SAP instances of the VNFFG. type: object required: - id Loading Loading @@ -852,6 +854,9 @@ definitions: description: > This type represents an NFP instance. It shall comply with the provisions defined in Table 6.5.3.66-1. NOTE: When multiple identifiers are included, the position of the identifier in the CpGroup data type specifies the position of the group in the path. type: object required: - id Loading Loading @@ -879,9 +884,7 @@ definitions: cpGroup: description: > Group(s) of CPs and/or SAPs which the NFP passes through. When multiple identifiers are included, the position of the identifier in the CpGroup data type specifies the position of the group in the path. See note. type: array minItems: 1 items: Loading Loading @@ -910,6 +913,10 @@ definitions: This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1. NOTE 1: For the VNF external CP instance, both vnfInstanceId and vnfExtCpInstanceId shall be present as a pair. NOTE 2: For the PNF external CP instance, both pnfInfoId and PnfExtCpInstanceId shall be present as a pair. NOTE 3: For the SAP instance, both nsInstanceId and nsSapInstanceId shall be present as a pair. NOTE 4: One pair of identifiers (VNF external CP, PNF external CP or SAP) shall be present. type: object oneOf: - required: Loading @@ -926,6 +933,7 @@ definitions: description: > Identifier of the VNF instance associated to the CP instance. This attribute shall be present if the CP instance is VNF external CP. See note 1 and note 4. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfExtCpInstanceId: description: > Loading Loading @@ -1047,6 +1055,11 @@ definitions: description: > This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1. NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. NOTE 2: An external CP instance is not associated to a link port in the cases indicated for the “extLinkPorts” attribute in clause 6.5.3.26. type: object required: - id Loading Loading @@ -1088,8 +1101,7 @@ definitions: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. An external CP instance is not associated to a link port in the cases indicated for the “extLinkPorts” attribute in clause 6.5.3.26. See note 2. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" metadata: description: > Loading @@ -1104,6 +1116,13 @@ definitions: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. $ref: "#/definitions/IdentifierInVnf" associatedVipCpId: description: > Identifier of the VIP CP instance that is exposed as this VnfExtCp instance, either directly or via a floating IP address, and the related "VipCpInfo" structure in "VnfInstance". Shall be present if the cpdId of this VnfExtCp has a vipCpd attribute. See note 1. $ref: "#/definitions/IdentifierInVnf" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents Loading Loading @@ -1229,6 +1248,9 @@ definitions: description: > This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1. NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported. type: object required: - layerProtocol Loading Loading @@ -1441,6 +1463,10 @@ definitions: description: > This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. NOTE 1: The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. NOTE 2: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. type: object required: - id Loading Loading @@ -1468,14 +1494,16 @@ definitions: If present, this attribute shall refer to a "secondary" ExtCpInfo item in the VNF instance that exposes a virtual IP CP instance which shares this linkport with the external CP instance referenced by the "cpInstanceId" attribute. The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. See note 1. $ref: "#/definitions/IdentifierInVnf" trunkResourceId: description: > Identifier of the trunk resource in the VIM. Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. See note 2. $ref: "#/definitions/IdentifierInVim" ExtManagedVirtualLinkInfo: Loading Loading @@ -1522,6 +1550,19 @@ definitions: VnfLinkPortInfo: type: object description: > This type represents a link port of an internal VL of a VNF. It shall comply with the provisions defined in table 6.5.3.64-1. NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType. NOTE 2: Annex A.4 of ETSI GS NFV-IFA 007 [19] provides examples for configurations where both vipCpInstanceId and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or only vipCpInstanceId is present (UC#6 and UC#6-b). NOTE 3: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. required: - id - resourceHandle Loading Loading @@ -1550,11 +1591,7 @@ definitions: (i.e. VNFC CP) instance. The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. See note 1. $ref: "#/definitions/IdentifierInVnf" cpInstanceType: description: > Loading @@ -1564,11 +1601,7 @@ definitions: Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. See note 1. type: string enum: - VNFC_CP Loading @@ -1576,20 +1609,14 @@ definitions: vipCpInstanceId: description: > VIP CP instance of the VNF connected to this link port. May be present. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. Annex A.4 of ETSI GS NFV-IFA 007 [19] provides examples for configurations where both vipCpInstanceId and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or only vipCpInstanceId is present (UC#6 and UC#6-b). See notes 1 and 2. $ref: "#/definitions/IdentifierInVnf" trunkResourceId: description: > Identifier of the trunk resource in the VIM. Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. See note 3. $ref: "#/definitions/IdentifierInVim" MonitoringParameter: Loading Loading @@ -1626,6 +1653,14 @@ definitions: description: > This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance. NOTE 1: ETSI GS NFV-SOL 001 (Available at https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/001/03.03.01_60/gs_NFV-SOL001v030301p.pdf) specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. NOTE 3: The information can be omitted because it is already available as part of the external CP information. type: object required: - id Loading @@ -1644,7 +1679,7 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vduId: description: > Reference to the applicable VDU in the VNFD. Reference to the applicable VDU in the VNFD. See note 1. $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" computeResource: description: > Loading @@ -1667,11 +1702,8 @@ definitions: CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. May be present otherwise. an external CP of the VNF instance.See note 2. May be present otherwise. type: array items: type: object Loading @@ -1686,20 +1718,20 @@ definitions: $ref: "#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. Identifier of the VDU CPD, cpdId, in the VNFD. See note 1. $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of the VNF instance or connected to an external CP of the VNF instance and shall be absent otherwise. A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of the VNF instance or connected to an external CP of the VNF instance (see note 2) and shall be absent otherwise. $ref: "#/definitions/IdentifierInVnf" cpProtocolInfo: description: > Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information. See note 3. type: array items: $ref: "#/definitions/CpProtocolInfo" Loading Loading @@ -1814,6 +1846,9 @@ definitions: description: > This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1. NOTE: When the NsVirtualLink, from which the present NsLinkPort is part of, is provided as an ExtVirtualLink as input of a VNF LCM operation, the id of the ExtLinkPort shall be the same as the corresponding NsLinkPort. type: object required: - id Loading Loading
src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +73 −38 Original line number Diff line number Diff line Loading @@ -806,6 +806,8 @@ definitions: VnffgInfo: description: > Information on the VNFFG(s) of the NS instance. NOTE: It indicates an exhaustive list of all the CP instances and SAP instances of the VNFFG. type: object required: - id Loading Loading @@ -852,6 +854,9 @@ definitions: description: > This type represents an NFP instance. It shall comply with the provisions defined in Table 6.5.3.66-1. NOTE: When multiple identifiers are included, the position of the identifier in the CpGroup data type specifies the position of the group in the path. type: object required: - id Loading Loading @@ -879,9 +884,7 @@ definitions: cpGroup: description: > Group(s) of CPs and/or SAPs which the NFP passes through. When multiple identifiers are included, the position of the identifier in the CpGroup data type specifies the position of the group in the path. See note. type: array minItems: 1 items: Loading Loading @@ -910,6 +913,10 @@ definitions: This type represents an identifier of the CP or SAP instance. It shall comply with the provisions defined in Table 6.5.3.56-1. NOTE 1: For the VNF external CP instance, both vnfInstanceId and vnfExtCpInstanceId shall be present as a pair. NOTE 2: For the PNF external CP instance, both pnfInfoId and PnfExtCpInstanceId shall be present as a pair. NOTE 3: For the SAP instance, both nsInstanceId and nsSapInstanceId shall be present as a pair. NOTE 4: One pair of identifiers (VNF external CP, PNF external CP or SAP) shall be present. type: object oneOf: - required: Loading @@ -926,6 +933,7 @@ definitions: description: > Identifier of the VNF instance associated to the CP instance. This attribute shall be present if the CP instance is VNF external CP. See note 1 and note 4. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfExtCpInstanceId: description: > Loading Loading @@ -1047,6 +1055,11 @@ definitions: description: > This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1. NOTE 1: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. NOTE 2: An external CP instance is not associated to a link port in the cases indicated for the “extLinkPorts” attribute in clause 6.5.3.26. type: object required: - id Loading Loading @@ -1088,8 +1101,7 @@ definitions: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. An external CP instance is not associated to a link port in the cases indicated for the “extLinkPorts” attribute in clause 6.5.3.26. See note 2. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" metadata: description: > Loading @@ -1104,6 +1116,13 @@ definitions: The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present. $ref: "#/definitions/IdentifierInVnf" associatedVipCpId: description: > Identifier of the VIP CP instance that is exposed as this VnfExtCp instance, either directly or via a floating IP address, and the related "VipCpInfo" structure in "VnfInstance". Shall be present if the cpdId of this VnfExtCp has a vipCpd attribute. See note 1. $ref: "#/definitions/IdentifierInVnf" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents Loading Loading @@ -1229,6 +1248,9 @@ definitions: description: > This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1. NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported. type: object required: - layerProtocol Loading Loading @@ -1441,6 +1463,10 @@ definitions: description: > This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. NOTE 1: The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. NOTE 2: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. type: object required: - id Loading Loading @@ -1468,14 +1494,16 @@ definitions: If present, this attribute shall refer to a "secondary" ExtCpInfo item in the VNF instance that exposes a virtual IP CP instance which shares this linkport with the external CP instance referenced by the "cpInstanceId" attribute. The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. See note 1. $ref: "#/definitions/IdentifierInVnf" trunkResourceId: description: > Identifier of the trunk resource in the VIM. Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. See note 2. $ref: "#/definitions/IdentifierInVim" ExtManagedVirtualLinkInfo: Loading Loading @@ -1522,6 +1550,19 @@ definitions: VnfLinkPortInfo: type: object description: > This type represents a link port of an internal VL of a VNF. It shall comply with the provisions defined in table 6.5.3.64-1. NOTE 1: Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType. NOTE 2: Annex A.4 of ETSI GS NFV-IFA 007 [19] provides examples for configurations where both vipCpInstanceId and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or only vipCpInstanceId is present (UC#6 and UC#6-b). NOTE 3: The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. required: - id - resourceHandle Loading Loading @@ -1550,11 +1591,7 @@ definitions: (i.e. VNFC CP) instance. The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. See note 1. $ref: "#/definitions/IdentifierInVnf" cpInstanceType: description: > Loading @@ -1564,11 +1601,7 @@ definitions: Permitted values: * VNFC_CP: The link port is connected to a VNFC CP * EXT_CP: The link port is associated to an external CP. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. See note 1. type: string enum: - VNFC_CP Loading @@ -1576,20 +1609,14 @@ definitions: vipCpInstanceId: description: > VIP CP instance of the VNF connected to this link port. May be present. Either cpInstanceId with cpInstanceType set to "EXT_CP" or any combination of cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId (i.e. one or both of them) shall be present for a VnfLinkPortInfo. In case both cpInstanceId with cpInstanceType set to "VNFC_CP" and vipCpInstanceId are present, the two different CP instances share the linkport. Annex A.4 of ETSI GS NFV-IFA 007 [19] provides examples for configurations where both vipCpInstanceId and vnfcCpInstanceId are present (UC#5 and UC#5-b), only vnfcCpInstanceId is present (UC#2), or only vipCpInstanceId is present (UC#6 and UC#6-b). See notes 1 and 2. $ref: "#/definitions/IdentifierInVnf" trunkResourceId: description: > Identifier of the trunk resource in the VIM. Shall be present if the present link port corresponds to the parent port that the trunk resource is associated with. The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute. See note 3. $ref: "#/definitions/IdentifierInVim" MonitoringParameter: Loading Loading @@ -1626,6 +1653,14 @@ definitions: description: > This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance. NOTE 1: ETSI GS NFV-SOL 001 (Available at https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/001/03.03.01_60/gs_NFV-SOL001v030301p.pdf) specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 2: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. NOTE 3: The information can be omitted because it is already available as part of the external CP information. type: object required: - id Loading @@ -1644,7 +1679,7 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vduId: description: > Reference to the applicable VDU in the VNFD. Reference to the applicable VDU in the VNFD. See note 1. $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" computeResource: description: > Loading @@ -1667,11 +1702,8 @@ definitions: CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance or is connected to an external CP of the VNF instance. A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. May be present otherwise. an external CP of the VNF instance.See note 2. May be present otherwise. type: array items: type: object Loading @@ -1686,20 +1718,20 @@ definitions: $ref: "#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. Identifier of the VDU CPD, cpdId, in the VNFD. See note 1. $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of the VNF instance or connected to an external CP of the VNF instance and shall be absent otherwise. A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of the VNF instance or connected to an external CP of the VNF instance (see note 2) and shall be absent otherwise. $ref: "#/definitions/IdentifierInVnf" cpProtocolInfo: description: > Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. The information can be omitted because it is already available as part of the external CP information. See note 3. type: array items: $ref: "#/definitions/CpProtocolInfo" Loading Loading @@ -1814,6 +1846,9 @@ definitions: description: > This type represents information about a link port of a VL instance. It shall comply with the provisions defined in Table 6.5.3.55-1. NOTE: When the NsVirtualLink, from which the present NsLinkPort is part of, is provided as an ExtVirtualLink as input of a VNF LCM operation, the id of the ExtLinkPort shall be the same as the corresponding NsLinkPort. type: object required: - id Loading