Loading src/SOL002/APIVersion/APIVersion.yaml +2 −2 Viewed Changes for src/SOL002/APIVersion/APIVersion.yaml: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V4.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf paths: /vnfconfig/api_versions: Loading src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml +320 −105 Viewed Changes for src/SOL002/General_Definitions/SOL002_def.yaml: 320 added lines, 105 removed lines. Original line number Diff line number Diff line Loading @@ -187,72 +187,87 @@ definitions: VimConnectionInfo: description: > This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This type represents parameters to connect to a VIM, a CISM, a CIR or a MCIOP repository for managing the resources of a VNF instance. This structure is used to convey VIM-related, CISM-related, CIR-related, or MCIOP-repository-relate dparameters over the Or-Vnfm interface. Additional parameters for a VIM, a CISM, a CIR or a MCIOP repository may be configured into the VNFM by means outside the scope of the present document and bound to the identifier of that VIM. * NOTE 1: If applicable, this attribute also provides information about the resourceGroupIds that are accessible using a particular set of credentials. See definition of "resourceGroupId" in clause 9.5.3.3. * NOTE 2: Once the connectivity between VNFM and VIM is provided through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM. * NOTE 2: Once the connectivity between VNFM and VIM, CISM, CIR or MCIOP repository is provided through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM., CISM, CIR or MCIOP repository. type: object required: - vimType properties: vimId: description: > The identifier of the VIM instance. This identifier is managed by the NFVO. Shall be present to address additional information about the VIM if such information has been configured into the VNFM by means outside the scope of the present document, and should be absent otherwise. The identifier of the VIM, CISM, CIR or MCIOP repository instance. This identifier is managed by the NFVO. Shall be present to address additional information about the VIM, CISM, CIR or MCIOP repository if such information has been configured into the VNFM by means outside the scope of the present document and should be absent otherwise. $ref: "#/definitions/Identifier" vimType: description: > Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003. Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM., CISM, CIR or MCIOP repository. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information [i.3] provides access to information about VimConnectionInfo definitions for various VIM, CISM, CIR or MCIOP repository types. The structure of the registry is defined in annex C. type: string interfaceInfo: description: > Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType. Alternatively, such information may have been configured into the VNFM and bound to the vimId. Information about the interface or interfaces to the VIM, CISM, CIR or MCIOP repository, if applicable, such as the URI of an interface endpoint to communicate with the VIM, CISM, CIR or MCIOP repository. The applicable keys are dependent on the content of vimType. Alternatively, such information may have been configured into the VNFM and bound to the vimId. $ref: "#/definitions/KeyValuePairs" accessInfo: description: > Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note 1). The applicable keys are dependent on the content of vimType. If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included. If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band. Authentication credentials for accessing the VIM, CISM, CIR or MCIOP repository and other access-related information such as tenants or infrastructure resource groups (see note 1). The applicable keys are dependent on the content of vimType. If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included. If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band. See note 2. $ref: "#/definitions/KeyValuePairs" extra: description: > VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. VIM, CISM, CIR or MCIOP repository type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. $ref: "#/definitions/KeyValuePairs" ResourceHandle: Loading @@ -260,18 +275,36 @@ definitions: - resourceId type: object description: > This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM. This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM. * NOTE 1: The information about the VIM or CISM connection referenced by the VIM connection id is known to the VNFM. Moreover, the identifier of the VIM connection provides scope to the resourceId. * NOTE 2: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or CISM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. * NOTE 3: When the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the 'metadata.name' field in Kubernetes® manifest. properties: vimConnectionId: description: > Identifier of the VIM connection to manage the resource. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "VnfInstance" structure. Identifier of the VIM or CISM connection to manage the resource. This attribute shall be supported when the resource is managed by a CISM. When the resource is managed by a VIM, this attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. See note 1. $ref: "#/definitions/Identifier" resourceProviderId: description: > Loading @@ -282,15 +315,26 @@ definitions: $ref: "#/definitions/Identifier" resourceId: description: > Identifier of the resource in the scope of the VIM or the resource provider. Identifier of the resource in the scope of the VIM or the CISM or the resource provider. See note 3. $ref: "#/definitions/IdentifierInVim" vimLevelResourceType: description: > The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the "type" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003). Type of the resource in the scope of the VIM or the CISM or the resource provider. See note 2. type: string vimLevelAdditionalResourceInfo: description: > Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. $ref: "#/definitions/AdditionalResourceInfo" containerNamespace: description: > The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise. type: string VnfExtCpData: Loading @@ -311,12 +355,12 @@ definitions: last key from the map removes the affected instance of the "VnfExtCpData" structure from its parent data structure. * NOTE 4: If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or "ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance different than the one that has used it before the operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure. "ChangeCurrentVnfPkg" operation, a cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance different than the one that has used it before the operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure. type: object required: - cpdId Loading @@ -330,7 +374,7 @@ definitions: Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf" and is managed by the API consumer. and is managed by the NFVO. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). See notes 2, 3 and 4. type: object Loading @@ -339,31 +383,49 @@ definitions: VnfExtCpConfig: description: > This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL. * NOTE: The following conditions apply to the attributes "linkPortId" and "cpProtocolData": This type represents an externally provided link port, or a network attachment definition resource of secondary container cluster network, or network address information per instance of an external connection point. In the case of VM-based deployment of the VNFC exposing the external CP: 1. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. 2. In case a link port is not provided, the VNFM shall create a link port on the external VL and use that link port to connect the external CP to the external VL. In the case of container-based deployment of the VNFC exposing the external CP, the VNFM shall use the network attachment definition resource of secondary container cluster network when connecting the CP to the external VL. * NOTE 1: The following conditions apply to the attributes "linkPortId" and "cpProtocolData" for an external CP instance connected or to be connected to a virtual network not categorized as secondary container cluster network: 1) Void. 2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance representing a subport that is to be created, or an external CP instance that is to be created by creating the corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing external CP instance that is to be re-configured or added to a particular external virtual link. 2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance representing a subport that is to be created, or an external CP instance that is to be created by creating the corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing external CP instance that is to be re-configured or added to a particular external virtual link. 3) If the "linkPortId" attribute is absent, the VNFM shall create a link port. 4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. 5) If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the 4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a precreated link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. 5) If both "cpProtocolData" and "linkportId" are provided, the NFVO shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". * NOTE 2: The following conditions apply to the attributes “netAttDefResourceId” and “cpProtocolData” for an external CP instance connected or to be connected to a secondary container cluster network: 1) The "netAttDefResourceId" and "cpProtocolData" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. 2) The "netAttDefResourceId" attribute shall be present and the "cpProtocolData" attribute may be present for a to-be-created external CP instance or an existing external CP instance. * NOTE 3: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment definition resource is needed to fulfil the connectivity requirements of the external CP, e.g. to build a link redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall belong to the same namespace as defined by the corresponding "netAttDefResourceNamespace" attribute in the "NetAttDefResourceData". * NOTE 4: Either linkPortId or netAttDefResourceId may be included, but not both. anyOf: - required: - linkPortId - required: - cpProtocolData - required: - netAttDefResourceId type: object properties: parentCpConfigId: Loading @@ -373,10 +435,11 @@ definitions: in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in a trunk, and if parent ports are supported. $ref: "#/definitions/IdentifierInVnf" linkPortId: description: > Identifier of a pre-configured link port to which the external CP will be associated. See note will be associated. See notes 1 and 4. $ref: "#/definitions/Identifier" createExtLinkPort: Loading @@ -390,12 +453,27 @@ definitions: cpProtocolData: description: > Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. Parameters for configuring the network protocols on the link port that connects the CP to a VL. See notes 1 and 2. type: array items: $ref: "#/definitions/CpProtocolData" netAttDefResourceId: description: > Identifier of the “NetAttDefResourceData” structure that provides the specification of the interface to attach the external CP to a secondary container cluster network. It is only applicable if the external CP is connected or to be connected to a secondary container cluster network. It shall not be present if the external CP is related to a virtual network not categorized as secondary container cluster network. See notes 2, 3 and 4. type: array items: $ref: "#/definitions/Identifier" CpProtocolData: description: > This type represents network protocol data. Loading @@ -408,16 +486,30 @@ definitions: properties: layerProtocol: description: > Identifier of layer(s) and protocol(s). See note. Identifier of layer(s) and protocol(s). Permitted values: - IP_OVER_ETHERNET. - IP_FOR_VIRTUAL_CP See note type: string enum: - IP_OVER_ETHERNET - IP_FOR_VIRTUAL_CP ipOverEthernet: description: > Network address data for IP over Ethernet to assign to the extCP Network address data for IP over Ethernet to assign to the external CP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise. $ref: "#/definitions/IpOverEthernetAddressData" virtualCpAddress: description: > IP address data to assign to an external CP instance exposing a virtual CP. It shall be present if layerProtocol is equal to “IP_FOR_VIRTUAL_CP” and the external CP instance exposes a virtual CP and shall not be present otherwise. $ref: "#/definitions/VirtualCpAddressData" IpOverEthernetAddressData: description: > Loading @@ -431,7 +523,7 @@ definitions: of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology. actually used by the NFVI's transport technology. type: object anyOf: - required: Loading Loading @@ -528,17 +620,53 @@ definitions: a subnet will be assigned. $ref: "#/definitions/IdentifierInVim" VirtualCpAddressData: 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: If the container cluster is set up to be able to configure an external load balancer this address will be used, otherwise it will be ignored by the CISM. * NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container cluster will assign an IP address. type: object required: - type properties: type: description: > The type of the IP addresses. Permitted values: IPV4, IPV6. type: string enum: - IPV4 - IPV6 loadBalancerIp: description: > Fixed address to assign to an external load balancer. See notes 1 and 2. $ref: "#/definitions/IpAddress" ExtVirtualLinkData: description: > This type represents an external VL. * NOTE: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases: 1 For a VIP CP directly exposed as extCP: 1.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD. 1.2 A dedicated IP addresss is allocated as VIP address, but the NFVO indicates that no port is needed (createExtLinkPort in VnfExtCpconfig set to false). 2 For a VIP CP exposed as extCP via a floating IP address: 2.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP associated to the VIP CP is also exposed via a floating IP addresss. * NOTE 1: The information about the VIM connection referenced by the VIM connection id is known to the VNFM. Moreover, the identifier of the VIM connection provides scope to the resourceId. * NOTE 2: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases: 1) For a VIP CP directly exposed as an external CP: 1.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD. 1.2) A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed (createExtLinkPort in VnfExtCpConfig set to false). 2) For a VIP CP exposed as an external CP via a floating IP address: 2.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP associated to the VIP CP is also exposed via a floating IP address. 3) For a VIRTUAL CP exposed as an external CP. 4) For a VNFC CP exposed as an external CP in a secondary container cluster external network. * NOTE 3: An example of the network attachment definition resource when the container infrastructure service management is a Kubernetes® instance is a network attachment definition (NAD). type: object required: - id Loading @@ -554,7 +682,7 @@ definitions: description: > Identifier of the VIM connection to manage this resource. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. resource management in direct mode is applicable. See note 1. $ref: "#/definitions/Identifier" resourceProviderId: description: > Loading @@ -579,15 +707,103 @@ definitions: $ref: "#/definitions/VnfExtCpData" extLinkPorts: description: > Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL unless the extCp exposes a VIP CP and a link port is not needed for it based on the conditions defined below. See note. Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL except in the cases defined below. See note 2. type: array items: $ref: "#/definitions/ExtLinkPortData" extNetAttDefResourceData: description: > Externally provided network attachment definition resource(s) that provide the specification of the interface to attach external CPs to this external VL. See note 3. It is only applicable if the external VL is realized by a secondary container cluster network. It shall not be present otherwise. type: array items: $ref: "#/definitions/NetAttDefResourceData" ScaleInfo: description: > This type represents the scale level of a VNF instance related to a scaling aspect. type: object required: - aspectId - scaleLevel properties: aspectId: description: > Identifier of the scaling aspect. $ref: "#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "#/definitions/IdentifierInVnfd" scaleToLevel: description: > Indicates the scale level. The minimum value shall be 0 and the maximum value shall be ≤ maxScaleLevel as described in the VNFD. $ref: "#/definitions/Identifier" AdditionalResourceInfo: description: > This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. * NOTE: At least one attribute shall be present. type: object properties: hostName: description: > Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note. type: string persistentVolume: description: > Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note. type: string additionalInfo: description: > Information related to other properties directly owned by the resource and available from the VIM or CISM or the resource provider. See note. $ref: "#/definitions/KeyValuePairs" NetAttDefResourceData: description: > This type represents a network attachment definition resource that provides the specification of the interface to be used to connect one or multiple connection points to a secondary container cluster network realizing a VL. type: object required: - netAttDefResourceId - resourceHandle properties: netAttDefResourceId: description: > Identifier of this network attachment definition resource as provided by the entity that has created it. $ref: "#/definitions/Identifier" resourceHandle: description: > Resource handle of the resource identifying the network attachment definition resource that provides the specification of the interface to attach the connection points to a secondary container cluster network. $ref: "#/definitions/ResourceHandle" Identifier: description: > An identifier with the intention of being globally unique. Loading Loading @@ -653,7 +869,7 @@ definitions: IdentifierInVim: description: > An identifier maintained by the VIM or other resource provider. It is An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. type: string Loading Loading @@ -760,7 +976,6 @@ definitions: VNF lifecycle operation types in VNF lifecycle management operation occurrence resources and VNF lifecycle management operation occurrence notifications. It shall comply with the provisions defined in table 5.5.4.5-1. Value | Description ------|------------ Loading src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +9 −14 Viewed Changes for src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml: 9 added lines, 14 removed lines. Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ definitions: as "deleteIdList" as defined below this table. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" VnfConfiguration: description: > Loading Loading @@ -86,16 +86,11 @@ definitions: type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfSpecificData: description: > Additional configurable properties of the VNF instance declared in the VNFD as "VnfConfigurableProperties". see note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' VnfcConfigurationData: description: > Loading @@ -110,7 +105,7 @@ definitions: description: > Identifier of a VNFC instance to which this set of configuration data applies. The identifier references the "id" attribute in a "VnfcInfo" structure. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' intCpConfig: description: > Configuration parameters for the internal CPs of the VNFC instance. Loading @@ -121,12 +116,12 @@ definitions: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' vnfcSpecificData: description: > Additional configurable properties of the VNFC instance declared in the VNFD as "VnfcConfigurableProperties". See note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' CpConfiguration: description: > Loading @@ -140,11 +135,11 @@ definitions: cpId: description: > Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' cpdId: description: > Identifier of the CPD in the VNFD. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd' addresses: description: > Network address and port assigned to the CP. Loading Loading @@ -177,11 +172,11 @@ definitions: macAddress: description: > Mac address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/MacAddress' ipAddress: description: > IP address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' useDynamicAddress: description: > Set to true if an address shall be assigned dynamically. Otherwise set to false. Loading src/SOL002/VNFConfiguration/VNFConfiguration.yaml +38 −4 Viewed Changes for src/SOL002/VNFConfiguration/VNFConfiguration.yaml: 38 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V4.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading Loading @@ -67,6 +67,9 @@ paths: patch: description: | This method sets or modifies a configuration resource. See clause 9.4.2.3.4. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match requestBody: $ref: '#/components/requestBodies/ConfigurationRequest' responses: Loading Loading @@ -132,11 +135,27 @@ components: schema: type: string Content-Type: description: The MIME type of the body of the response. description: > The MIME type of the body of the response. style: simple explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading @@ -160,6 +179,21 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +372 −22 Viewed Changes for src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml: 372 added lines, 22 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,7 @@ definitions: Alarm: description: > The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in table 7.5.2.4-1. The alarm data type encapsulates information about an alarm. If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", the following provisions apply for the values of the attribute "faultDetails" related to Loading Loading @@ -44,11 +43,11 @@ definitions: id: description: > Identifier of this Alarm information element. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" managedObjectId: description: > Identifier of the affected VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" vnfcInstanceIds: description: > Identifiers of the affected VNFC instances. Each identifier references the Loading @@ -56,33 +55,33 @@ definitions: at least one VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf" rootCauseFaultyResource: description: > The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects virtualised resources. See note 1. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo" $ref: "#/definitions/FaultyResourceInfo" alarmRaisedTime: description: > Time stamp indicating when the alarm is raised by the managed object. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmChangedTime: description: > Time stamp indicating when the alarm was last changed. It shall be present if the alarm has been updated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmClearedTime: description: > Time stamp indicating when the alarm was cleared. It shall be present if the alarm has been cleared. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmAcknowledgedTime: description: > Time stamp indicating when the alarm was acknowledged. It shall be present if the alarm has been acknowledged. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" ackState: description: > Acknowledgement state of the alarm. Loading @@ -96,15 +95,15 @@ definitions: perceivedSeverity: description: > Perceived severity of the managed object failure. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" $ref: "#/definitions/PerceivedSeverityType" eventTime: description: > Time stamp indicating when the fault was observed. See note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" eventType: description: > Type of event. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" $ref: "#/definitions/EventType" type: string faultType: description: > Loading @@ -128,13 +127,13 @@ definitions: Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Boolean" correlatedAlarmIds: description: > List of identifiers of other alarms correlated to this fault. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" faultDetails: description: > Provides additional information about the fault. See notes 1 and 2. Loading @@ -151,13 +150,13 @@ definitions: self: description: > URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" objectInstance: description: > Link to the resource representing the VNF instance to which the notified alarm is correlated. Shall be present if the VNF instance information is accessible as a resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmNotification: description: > Loading @@ -180,7 +179,7 @@ definitions: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to Loading @@ -191,11 +190,11 @@ definitions: subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarm: description: > Information about an alarm including AlarmId, affected VNF Loading @@ -211,7 +210,7 @@ definitions: subscription: description: > Link to the related subscription. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" PerceivedSeverityRequest: description: > Loading @@ -223,4 +222,355 @@ definitions: proposedPerceivedSeverity: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" No newline at end of file $ref: "#/definitions/PerceivedSeverityType" FmSubscriptionRequest: description: > This type represents a subscription request related to notifications about VNF faults. type: object required: - callbackUri properties: filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication" FmSubscription: description: > This type represents a subscription related to notifications about VNF faults. type: object required: - id - callbackUri - _links properties: id: description: > Identifier of this "Individual subscription" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" _links: description: > Links for this resource. type: object required: - self properties: self: description: > URI of this resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmClearedNotification: description: > This type represents an alarm cleared notification about VNF faults. The notification shall be triggered by the VNFM when an alarm has been cleared. type: object required: - id - notificationType - subscriptionId - timeStamp - alarmId - alarmClearedTime - _links properties: id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "AlarmClearedNotification" for this notification type. type: string enum: - AlarmClearedNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmId: description: > Alarm identifier. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" alarmClearedTime: description: > The time stamp indicating when the alarm was cleared. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" _links: description: > Links to resources related to this notification. type: object required: - subscription - alarm properties: subscription: description: > Link to the related subscription. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" alarm: description: > Link to the resource that represents the related alarm. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" AlarmListRebuiltNotification: description: > This type represents a notification that the alarm list has been rebuilt, e.g. if the VNFM detects its storage holding the alarm list is corrupted. The notification shall be triggered by the VNFM when the alarm list has been rebuilt, e.g. because the VNFM has detected that its storage holding the alarm list was corrupted. type: object required: - id - notificationType - subscriptionId - timeStamp - _links properties: id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "AlarmListRebuiltNotification" for this notification type. type: string enum: - AlarmListRebuiltNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" _links: description: > Links to resources related to this notification. type: object required: - subscription - alarms properties: subscription: description: > Link to the related subscription. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" alarms: description: > Link to the alarm list, i.e. the "Alarms" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" AlarmModifications: description: > This type represents attribute modifications for an "Individual alarm" resource, i.e. modifications to a resource representation based on the "Alarm" data type. The attributes of "Alarm" that can be modified are included in the "AlarmModifications" data type. type: object required: - ackState properties: ackState: description: > New value of the "ackState" attribute in "Alarm". Permitted values: * ACKNOWLEDGED * UNACKNOWLEDGED type: string enum: - ACKNOWLEDGED - UNACKNOWLEDGED EventType: description: > The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). * QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). type: string enum: - COMMUNICATIONS_ALARM - PROCESSING_ERROR_ALARM - ENVIRONMENTAL_ALARM - QOS_ALARM - EQUIPMENT_ALARM FaultyResourceInfo: description: > This type represents the faulty virtual resources that have a negative impact on a VNF. type: object required: - faultyResource - faultyResourceType properties: faultyResource: description: > Information that identifies the faulty resource instance and its managing entity. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceHandle" faultyResourceType: description: > Type of the faulty resource. $ref: "#/definitions/FaultyResourceType" FaultyResourceType: description: > The enumeration FaultyResourceType represents those types of faulty resource. type: string enum: - COMPUTE - STORAGE - NETWORK FmNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF faults. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. type: object properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/VnfInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. Permitted values: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification See note. type: array items: type: string enum: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification faultyResourceTypes: description: > Match VNF alarms with a faulty resource type listed in this attribute. type: array items: $ref: "#/definitions/FaultyResourceType" perceivedSeverities: description: > Match VNF alarms with a perceived severity listed in this attribute. type: array items: $ref: "#/definitions/PerceivedSeverityType" eventTypes: description: > Match VNF alarms with an event type listed in this attribute. type: array items: $ref: "#/definitions/EventType" probableCauses: description: > Match VNF alarms with a probable cause listed in this attribute. type: array items: type: string PerceivedSeverityType: description: > Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability needs to be restored (ITU-T Recommendation X.733). * MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability needs to be restored (ITU-T Recommendation X.733). * MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object (ITU-T Recommendation X.733). * WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault (ITU-T Recommendation X.733). * INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733). * CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given) (ITU-T Recommendation X.733). type: string enum: - CRITICAL - MAJOR - MINOR - WARNING - INDETERMINATE - CLEARED No newline at end of file Loading
src/SOL002/APIVersion/APIVersion.yaml +2 −2 Viewed Changes for src/SOL002/APIVersion/APIVersion.yaml: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -19,8 +19,8 @@ info: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V4.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf paths: /vnfconfig/api_versions: Loading
src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml +320 −105 Viewed Changes for src/SOL002/General_Definitions/SOL002_def.yaml: 320 added lines, 105 removed lines. Original line number Diff line number Diff line Loading @@ -187,72 +187,87 @@ definitions: VimConnectionInfo: description: > This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This type represents parameters to connect to a VIM, a CISM, a CIR or a MCIOP repository for managing the resources of a VNF instance. This structure is used to convey VIM-related, CISM-related, CIR-related, or MCIOP-repository-relate dparameters over the Or-Vnfm interface. Additional parameters for a VIM, a CISM, a CIR or a MCIOP repository may be configured into the VNFM by means outside the scope of the present document and bound to the identifier of that VIM. * NOTE 1: If applicable, this attribute also provides information about the resourceGroupIds that are accessible using a particular set of credentials. See definition of "resourceGroupId" in clause 9.5.3.3. * NOTE 2: Once the connectivity between VNFM and VIM is provided through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM. * NOTE 2: Once the connectivity between VNFM and VIM, CISM, CIR or MCIOP repository is provided through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface endpoint of the VIM., CISM, CIR or MCIOP repository. type: object required: - vimType properties: vimId: description: > The identifier of the VIM instance. This identifier is managed by the NFVO. Shall be present to address additional information about the VIM if such information has been configured into the VNFM by means outside the scope of the present document, and should be absent otherwise. The identifier of the VIM, CISM, CIR or MCIOP repository instance. This identifier is managed by the NFVO. Shall be present to address additional information about the VIM, CISM, CIR or MCIOP repository if such information has been configured into the VNFM by means outside the scope of the present document and should be absent otherwise. $ref: "#/definitions/Identifier" vimType: description: > Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003. Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM., CISM, CIR or MCIOP repository. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information [i.3] provides access to information about VimConnectionInfo definitions for various VIM, CISM, CIR or MCIOP repository types. The structure of the registry is defined in annex C. type: string interfaceInfo: description: > Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType. Alternatively, such information may have been configured into the VNFM and bound to the vimId. Information about the interface or interfaces to the VIM, CISM, CIR or MCIOP repository, if applicable, such as the URI of an interface endpoint to communicate with the VIM, CISM, CIR or MCIOP repository. The applicable keys are dependent on the content of vimType. Alternatively, such information may have been configured into the VNFM and bound to the vimId. $ref: "#/definitions/KeyValuePairs" accessInfo: description: > Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note 1). The applicable keys are dependent on the content of vimType. If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included. If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band. Authentication credentials for accessing the VIM, CISM, CIR or MCIOP repository and other access-related information such as tenants or infrastructure resource groups (see note 1). The applicable keys are dependent on the content of vimType. If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included. If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band. See note 2. $ref: "#/definitions/KeyValuePairs" extra: description: > VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. VIM, CISM, CIR or MCIOP repository type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType. $ref: "#/definitions/KeyValuePairs" ResourceHandle: Loading @@ -260,18 +275,36 @@ definitions: - resourceId type: object description: > This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM. This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM. * NOTE 1: The information about the VIM or CISM connection referenced by the VIM connection id is known to the VNFM. Moreover, the identifier of the VIM connection provides scope to the resourceId. * NOTE 2: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or CISM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the 'kind' field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. * NOTE 3: When the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the 'metadata.name' field in Kubernetes® manifest. properties: vimConnectionId: description: > Identifier of the VIM connection to manage the resource. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "VnfInstance" structure. Identifier of the VIM or CISM connection to manage the resource. This attribute shall be supported when the resource is managed by a CISM. When the resource is managed by a VIM, this attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. See note 1. $ref: "#/definitions/Identifier" resourceProviderId: description: > Loading @@ -282,15 +315,26 @@ definitions: $ref: "#/definitions/Identifier" resourceId: description: > Identifier of the resource in the scope of the VIM or the resource provider. Identifier of the resource in the scope of the VIM or the CISM or the resource provider. See note 3. $ref: "#/definitions/IdentifierInVim" vimLevelResourceType: description: > The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle. This value set is different from the value set of the "type" attribute in the ResourceDefinition (refer to clause 9.5.3.2 in SOL003). Type of the resource in the scope of the VIM or the CISM or the resource provider. See note 2. type: string vimLevelAdditionalResourceInfo: description: > Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. $ref: "#/definitions/AdditionalResourceInfo" containerNamespace: description: > The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise. type: string VnfExtCpData: Loading @@ -311,12 +355,12 @@ definitions: last key from the map removes the affected instance of the "VnfExtCpData" structure from its parent data structure. * NOTE 4: If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or "ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance different than the one that has used it before the operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure. "ChangeCurrentVnfPkg" operation, a cpConfig map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance different than the one that has used it before the operation, or by no external CP instance at all. Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related "cpConfig" map entries to a new "extCpData" structure. type: object required: - cpdId Loading @@ -330,7 +374,7 @@ definitions: Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf" and is managed by the API consumer. and is managed by the NFVO. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). See notes 2, 3 and 4. type: object Loading @@ -339,31 +383,49 @@ definitions: VnfExtCpConfig: description: > This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL. * NOTE: The following conditions apply to the attributes "linkPortId" and "cpProtocolData": This type represents an externally provided link port, or a network attachment definition resource of secondary container cluster network, or network address information per instance of an external connection point. In the case of VM-based deployment of the VNFC exposing the external CP: 1. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. 2. In case a link port is not provided, the VNFM shall create a link port on the external VL and use that link port to connect the external CP to the external VL. In the case of container-based deployment of the VNFC exposing the external CP, the VNFM shall use the network attachment definition resource of secondary container cluster network when connecting the CP to the external VL. * NOTE 1: The following conditions apply to the attributes "linkPortId" and "cpProtocolData" for an external CP instance connected or to be connected to a virtual network not categorized as secondary container cluster network: 1) Void. 2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance representing a subport that is to be created, or an external CP instance that is to be created by creating the corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing external CP instance that is to be re-configured or added to a particular external virtual link. 2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance representing a subport that is to be created, or an external CP instance that is to be created by creating the corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing external CP instance that is to be re-configured or added to a particular external virtual link. 3) If the "linkPortId" attribute is absent, the VNFM shall create a link port. 4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a pre created link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. 5) If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the 4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a precreated link port, and the VNFM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port. 5) If both "cpProtocolData" and "linkportId" are provided, the NFVO shall ensure that the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". * NOTE 2: The following conditions apply to the attributes “netAttDefResourceId” and “cpProtocolData” for an external CP instance connected or to be connected to a secondary container cluster network: 1) The "netAttDefResourceId" and "cpProtocolData" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. 2) The "netAttDefResourceId" attribute shall be present and the "cpProtocolData" attribute may be present for a to-be-created external CP instance or an existing external CP instance. * NOTE 3: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment definition resource is needed to fulfil the connectivity requirements of the external CP, e.g. to build a link redundant mated pair in SR-IOV cases. When more than one netAttDefResourceId is indicated, all shall belong to the same namespace as defined by the corresponding "netAttDefResourceNamespace" attribute in the "NetAttDefResourceData". * NOTE 4: Either linkPortId or netAttDefResourceId may be included, but not both. anyOf: - required: - linkPortId - required: - cpProtocolData - required: - netAttDefResourceId type: object properties: parentCpConfigId: Loading @@ -373,10 +435,11 @@ definitions: in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in a trunk, and if parent ports are supported. $ref: "#/definitions/IdentifierInVnf" linkPortId: description: > Identifier of a pre-configured link port to which the external CP will be associated. See note will be associated. See notes 1 and 4. $ref: "#/definitions/Identifier" createExtLinkPort: Loading @@ -390,12 +453,27 @@ definitions: cpProtocolData: description: > Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note. Parameters for configuring the network protocols on the link port that connects the CP to a VL. See notes 1 and 2. type: array items: $ref: "#/definitions/CpProtocolData" netAttDefResourceId: description: > Identifier of the “NetAttDefResourceData” structure that provides the specification of the interface to attach the external CP to a secondary container cluster network. It is only applicable if the external CP is connected or to be connected to a secondary container cluster network. It shall not be present if the external CP is related to a virtual network not categorized as secondary container cluster network. See notes 2, 3 and 4. type: array items: $ref: "#/definitions/Identifier" CpProtocolData: description: > This type represents network protocol data. Loading @@ -408,16 +486,30 @@ definitions: properties: layerProtocol: description: > Identifier of layer(s) and protocol(s). See note. Identifier of layer(s) and protocol(s). Permitted values: - IP_OVER_ETHERNET. - IP_FOR_VIRTUAL_CP See note type: string enum: - IP_OVER_ETHERNET - IP_FOR_VIRTUAL_CP ipOverEthernet: description: > Network address data for IP over Ethernet to assign to the extCP Network address data for IP over Ethernet to assign to the external CP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise. $ref: "#/definitions/IpOverEthernetAddressData" virtualCpAddress: description: > IP address data to assign to an external CP instance exposing a virtual CP. It shall be present if layerProtocol is equal to “IP_FOR_VIRTUAL_CP” and the external CP instance exposes a virtual CP and shall not be present otherwise. $ref: "#/definitions/VirtualCpAddressData" IpOverEthernetAddressData: description: > Loading @@ -431,7 +523,7 @@ definitions: of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology. actually used by the NFVI's transport technology. type: object anyOf: - required: Loading Loading @@ -528,17 +620,53 @@ definitions: a subnet will be assigned. $ref: "#/definitions/IdentifierInVim" VirtualCpAddressData: 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: If the container cluster is set up to be able to configure an external load balancer this address will be used, otherwise it will be ignored by the CISM. * NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the container cluster will assign an IP address. type: object required: - type properties: type: description: > The type of the IP addresses. Permitted values: IPV4, IPV6. type: string enum: - IPV4 - IPV6 loadBalancerIp: description: > Fixed address to assign to an external load balancer. See notes 1 and 2. $ref: "#/definitions/IpAddress" ExtVirtualLinkData: description: > This type represents an external VL. * NOTE: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases: 1 For a VIP CP directly exposed as extCP: 1.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD. 1.2 A dedicated IP addresss is allocated as VIP address, but the NFVO indicates that no port is needed (createExtLinkPort in VnfExtCpconfig set to false). 2 For a VIP CP exposed as extCP via a floating IP address: 2.1 No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP associated to the VIP CP is also exposed via a floating IP addresss. * NOTE 1: The information about the VIM connection referenced by the VIM connection id is known to the VNFM. Moreover, the identifier of the VIM connection provides scope to the resourceId. * NOTE 2: A link port is not needed for an external CP instance that exposes a VIP CP in the following cases: 1) For a VIP CP directly exposed as an external CP: 1.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD. 1.2) A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed (createExtLinkPort in VnfExtCpConfig set to false). 2) For a VIP CP exposed as an external CP via a floating IP address: 2.1) No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP associated to the VIP CP is also exposed via a floating IP address. 3) For a VIRTUAL CP exposed as an external CP. 4) For a VNFC CP exposed as an external CP in a secondary container cluster external network. * NOTE 3: An example of the network attachment definition resource when the container infrastructure service management is a Kubernetes® instance is a network attachment definition (NAD). type: object required: - id Loading @@ -554,7 +682,7 @@ definitions: description: > Identifier of the VIM connection to manage this resource. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. resource management in direct mode is applicable. See note 1. $ref: "#/definitions/Identifier" resourceProviderId: description: > Loading @@ -579,15 +707,103 @@ definitions: $ref: "#/definitions/VnfExtCpData" extLinkPorts: description: > Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL unless the extCp exposes a VIP CP and a link port is not needed for it based on the conditions defined below. See note. Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL except in the cases defined below. See note 2. type: array items: $ref: "#/definitions/ExtLinkPortData" extNetAttDefResourceData: description: > Externally provided network attachment definition resource(s) that provide the specification of the interface to attach external CPs to this external VL. See note 3. It is only applicable if the external VL is realized by a secondary container cluster network. It shall not be present otherwise. type: array items: $ref: "#/definitions/NetAttDefResourceData" ScaleInfo: description: > This type represents the scale level of a VNF instance related to a scaling aspect. type: object required: - aspectId - scaleLevel properties: aspectId: description: > Identifier of the scaling aspect. $ref: "#/definitions/IdentifierInVnfd" vnfdId: description: > Identifier of the VNFD. Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change current VNF package" operation or due to its final failure). $ref: "#/definitions/IdentifierInVnfd" scaleToLevel: description: > Indicates the scale level. The minimum value shall be 0 and the maximum value shall be ≤ maxScaleLevel as described in the VNFD. $ref: "#/definitions/Identifier" AdditionalResourceInfo: description: > This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. * NOTE: At least one attribute shall be present. type: object properties: hostName: description: > Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note. type: string persistentVolume: description: > Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note. type: string additionalInfo: description: > Information related to other properties directly owned by the resource and available from the VIM or CISM or the resource provider. See note. $ref: "#/definitions/KeyValuePairs" NetAttDefResourceData: description: > This type represents a network attachment definition resource that provides the specification of the interface to be used to connect one or multiple connection points to a secondary container cluster network realizing a VL. type: object required: - netAttDefResourceId - resourceHandle properties: netAttDefResourceId: description: > Identifier of this network attachment definition resource as provided by the entity that has created it. $ref: "#/definitions/Identifier" resourceHandle: description: > Resource handle of the resource identifying the network attachment definition resource that provides the specification of the interface to attach the connection points to a secondary container cluster network. $ref: "#/definitions/ResourceHandle" Identifier: description: > An identifier with the intention of being globally unique. Loading Loading @@ -653,7 +869,7 @@ definitions: IdentifierInVim: description: > An identifier maintained by the VIM or other resource provider. It is An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. type: string Loading Loading @@ -760,7 +976,6 @@ definitions: VNF lifecycle operation types in VNF lifecycle management operation occurrence resources and VNF lifecycle management operation occurrence notifications. It shall comply with the provisions defined in table 5.5.4.5-1. Value | Description ------|------------ Loading
src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +9 −14 Viewed Changes for src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml: 9 added lines, 14 removed lines. Original line number Diff line number Diff line Loading @@ -53,7 +53,7 @@ definitions: as "deleteIdList" as defined below this table. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" VnfConfiguration: description: > Loading Loading @@ -86,16 +86,11 @@ definitions: type: array items: $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfSpecificData: description: > Additional configurable properties of the VNF instance declared in the VNFD as "VnfConfigurableProperties". see note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' VnfcConfigurationData: description: > Loading @@ -110,7 +105,7 @@ definitions: description: > Identifier of a VNFC instance to which this set of configuration data applies. The identifier references the "id" attribute in a "VnfcInfo" structure. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' intCpConfig: description: > Configuration parameters for the internal CPs of the VNFC instance. Loading @@ -121,12 +116,12 @@ definitions: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' vnfcSpecificData: description: > Additional configurable properties of the VNFC instance declared in the VNFD as "VnfcConfigurableProperties". See note. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs' CpConfiguration: description: > Loading @@ -140,11 +135,11 @@ definitions: cpId: description: > Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf' cpdId: description: > Identifier of the CPD in the VNFD. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd' addresses: description: > Network address and port assigned to the CP. Loading Loading @@ -177,11 +172,11 @@ definitions: macAddress: description: > Mac address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/MacAddress' ipAddress: description: > IP address. See NOTE 2. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' $ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress' useDynamicAddress: description: > Set to true if an address shall be assigned dynamically. Otherwise set to false. Loading
src/SOL002/VNFConfiguration/VNFConfiguration.yaml +38 −4 Viewed Changes for src/SOL002/VNFConfiguration/VNFConfiguration.yaml: 38 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf description: ETSI GS NFV-SOL 002 V4.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf servers: - url: http://127.0.0.1/vnfconfig/v1 Loading Loading @@ -67,6 +67,9 @@ paths: patch: description: | This method sets or modifies a configuration resource. See clause 9.4.2.3.4. parameters: - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since - $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match requestBody: $ref: '#/components/requestBodies/ConfigurationRequest' responses: Loading Loading @@ -132,11 +135,27 @@ components: schema: type: string Content-Type: description: The MIME type of the body of the response. description: > The MIME type of the body of the response. style: simple explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading @@ -160,6 +179,21 @@ components: explode: false schema: type: string ETag: description: > Used to provide the current entity-tag for the selected resource representation. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string Last-Modified: description: > Used to provide a timestamp indicating the date and time at which the server believes the selected resource representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses. style: simple schema: type: string format: date-time content: application/json: schema: Loading
src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +372 −22 Viewed Changes for src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml: 372 added lines, 22 removed lines. Original line number Diff line number Diff line Loading @@ -4,8 +4,7 @@ definitions: Alarm: description: > The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in table 7.5.2.4-1. The alarm data type encapsulates information about an alarm. If the attribute "faultType" has the value "NFVI_OAM_VIRTUALISED_RESOURCE_STATE_CHANGE", the following provisions apply for the values of the attribute "faultDetails" related to Loading Loading @@ -44,11 +43,11 @@ definitions: id: description: > Identifier of this Alarm information element. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" managedObjectId: description: > Identifier of the affected VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" vnfcInstanceIds: description: > Identifiers of the affected VNFC instances. Each identifier references the Loading @@ -56,33 +55,33 @@ definitions: at least one VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf" rootCauseFaultyResource: description: > The virtualised resources that are causing the VNF fault. Shall be present if the alarm affects virtualised resources. See note 1. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo" $ref: "#/definitions/FaultyResourceInfo" alarmRaisedTime: description: > Time stamp indicating when the alarm is raised by the managed object. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmChangedTime: description: > Time stamp indicating when the alarm was last changed. It shall be present if the alarm has been updated. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmClearedTime: description: > Time stamp indicating when the alarm was cleared. It shall be present if the alarm has been cleared. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmAcknowledgedTime: description: > Time stamp indicating when the alarm was acknowledged. It shall be present if the alarm has been acknowledged. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" ackState: description: > Acknowledgement state of the alarm. Loading @@ -96,15 +95,15 @@ definitions: perceivedSeverity: description: > Perceived severity of the managed object failure. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" $ref: "#/definitions/PerceivedSeverityType" eventTime: description: > Time stamp indicating when the fault was observed. See note 2. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" eventType: description: > Type of event. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" $ref: "#/definitions/EventType" type: string faultType: description: > Loading @@ -128,13 +127,13 @@ definitions: Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Boolean" correlatedAlarmIds: description: > List of identifiers of other alarms correlated to this fault. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" faultDetails: description: > Provides additional information about the fault. See notes 1 and 2. Loading @@ -151,13 +150,13 @@ definitions: self: description: > URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" objectInstance: description: > Link to the resource representing the VNF instance to which the notified alarm is correlated. Shall be present if the VNF instance information is accessible as a resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmNotification: description: > Loading @@ -180,7 +179,7 @@ definitions: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to Loading @@ -191,11 +190,11 @@ definitions: subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarm: description: > Information about an alarm including AlarmId, affected VNF Loading @@ -211,7 +210,7 @@ definitions: subscription: description: > Link to the related subscription. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" PerceivedSeverityRequest: description: > Loading @@ -223,4 +222,355 @@ definitions: proposedPerceivedSeverity: description: > Indicates the proposed escalated perceived severity for an alarm. $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" No newline at end of file $ref: "#/definitions/PerceivedSeverityType" FmSubscriptionRequest: description: > This type represents a subscription request related to notifications about VNF faults. type: object required: - callbackUri properties: filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/SubscriptionAuthentication" FmSubscription: description: > This type represents a subscription related to notifications about VNF faults. type: object required: - id - callbackUri - _links properties: id: description: > Identifier of this "Individual subscription" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. $ref: "#/definitions/FmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Uri" _links: description: > Links for this resource. type: object required: - self properties: self: description: > URI of this resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Link" AlarmClearedNotification: description: > This type represents an alarm cleared notification about VNF faults. The notification shall be triggered by the VNFM when an alarm has been cleared. type: object required: - id - notificationType - subscriptionId - timeStamp - alarmId - alarmClearedTime - _links properties: id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "AlarmClearedNotification" for this notification type. type: string enum: - AlarmClearedNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" alarmId: description: > Alarm identifier. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" alarmClearedTime: description: > The time stamp indicating when the alarm was cleared. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" _links: description: > Links to resources related to this notification. type: object required: - subscription - alarm properties: subscription: description: > Link to the related subscription. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" alarm: description: > Link to the resource that represents the related alarm. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" AlarmListRebuiltNotification: description: > This type represents a notification that the alarm list has been rebuilt, e.g. if the VNFM detects its storage holding the alarm list is corrupted. The notification shall be triggered by the VNFM when the alarm list has been rebuilt, e.g. because the VNFM has detected that its storage holding the alarm list was corrupted. type: object required: - id - notificationType - subscriptionId - timeStamp - _links properties: id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" notificationType: description: > Discriminator for the different notification types. Shall be set to "AlarmListRebuiltNotification" for this notification type. type: string enum: - AlarmListRebuiltNotification subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/DateTime" _links: description: > Links to resources related to this notification. type: object required: - subscription - alarms properties: subscription: description: > Link to the related subscription. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" alarms: description: > Link to the alarm list, i.e. the "Alarms" resource. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/NotificationLink" AlarmModifications: description: > This type represents attribute modifications for an "Individual alarm" resource, i.e. modifications to a resource representation based on the "Alarm" data type. The attributes of "Alarm" that can be modified are included in the "AlarmModifications" data type. type: object required: - ackState properties: ackState: description: > New value of the "ackState" attribute in "Alarm". Permitted values: * ACKNOWLEDGED * UNACKNOWLEDGED type: string enum: - ACKNOWLEDGED - UNACKNOWLEDGED EventType: description: > The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the procedure and/or process required conveying information from one point to another (ITU-T Recommendation X.733). * PROCESSING_ERROR_ALARM: An alarm of this type is associated with a software or processing fault (ITU-T Recommendation X.733). * ENVIRONMENTAL_ALARM: An alarm of this type is associated with a condition related to an enclosure in which the equipment resides (ITU-T Recommendation X.733). * QOS_ALARM: An alarm of this type is associated with degradation in the quality of a service (ITU-T Recommendation X.733). * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). type: string enum: - COMMUNICATIONS_ALARM - PROCESSING_ERROR_ALARM - ENVIRONMENTAL_ALARM - QOS_ALARM - EQUIPMENT_ALARM FaultyResourceInfo: description: > This type represents the faulty virtual resources that have a negative impact on a VNF. type: object required: - faultyResource - faultyResourceType properties: faultyResource: description: > Information that identifies the faulty resource instance and its managing entity. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/ResourceHandle" faultyResourceType: description: > Type of the faulty resource. $ref: "#/definitions/FaultyResourceType" FaultyResourceType: description: > The enumeration FaultyResourceType represents those types of faulty resource. type: string enum: - COMPUTE - STORAGE - NETWORK FmNotificationsFilter: description: > This type represents a subscription filter related to notifications about VNF faults. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. type: object properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/VnfInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. Permitted values: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification See note. type: array items: type: string enum: - AlarmNotification - AlarmClearedNotification - AlarmListRebuiltNotification faultyResourceTypes: description: > Match VNF alarms with a faulty resource type listed in this attribute. type: array items: $ref: "#/definitions/FaultyResourceType" perceivedSeverities: description: > Match VNF alarms with a perceived severity listed in this attribute. type: array items: $ref: "#/definitions/PerceivedSeverityType" eventTypes: description: > Match VNF alarms with an event type listed in this attribute. type: array items: $ref: "#/definitions/EventType" probableCauses: description: > Match VNF alarms with a probable cause listed in this attribute. type: array items: type: string PerceivedSeverityType: description: > Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability needs to be restored (ITU-T Recommendation X.733). * MAJOR: The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability needs to be restored (ITU-T Recommendation X.733). * MINOR: The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object (ITU-T Recommendation X.733). * WARNING: The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault (ITU-T Recommendation X.733). * INDETERMINATE: The Indeterminate severity level indicates that the severity level cannot be determined (ITU-T Recommendation X.733). * CLEARED: The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given) (ITU-T Recommendation X.733). type: string enum: - CRITICAL - MAJOR - MINOR - WARNING - INDETERMINATE - CLEARED No newline at end of file