The following model is the GenDoc output of the Vnf and Common sub-model artifacts relevant to the updating of the VNFD model to ETSI IFA011 v2.5.1
Diagrams
VNFD View
VNFD Topology View
Vnf Deployment Flavor
Classes from VNF Sub-Model
Vnfd
A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains connectivity, interface and virtualised resource requirements.
Parent class: NetworkFunctionDesc
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfProvider | String | 1 | Preliminary OpenModelAttribute
| Provider of the VNF and of the VNFD.
|
vnfProductName | String | 1 | Preliminary OpenModelAttribute
| Name to identify the VNF Product. Invariant for the VNF Product lifetime.
|
vnfSoftwareVersion | Version | 1 | Preliminary OpenModelAttribute
| Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package.
|
vnfdVersion | Version | 1 | Preliminary OpenModelAttribute
| Identifies the version of the VNFD.
|
vnfProductInfoName | String | 0..1 | Preliminary OpenModelAttribute
| Human readable name for the VNF Product. Can change during the VNF Product lifetime.
|
vnfProductInfoDescription | String | 0..1 | Preliminary OpenModelAttribute
| Human readable description of the VNF Product. Can change during the VNF Product lifetime.
|
vnfmInfo | String | 0..* | Preliminary OpenModelAttribute
| Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. Use the name of micro-service of the vnfm drive. For vendor specific VNFM, the value composes of "vendorname" and "vnfmdriver", e.g. "mycompanyvnfmdriver"; for generic VNFM, the value is "gvnfmdriver".
|
localizationLanguage | String | 0..* | Preliminary OpenModelAttribute
| Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time.
|
modifiableAttributes | VnfInfoModifiableAttributes | 0..1 | Preliminary OpenModelAttribute
| Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation.
|
vnfdId | Identifier | 1 | Preliminary OpenModelAttribute
| Identifier of this VNFD information element. This attribute shall be globally unique. NOTE: The VNFD Identifier shall be used as the unique identifier of the VNF Package that contains this VNFD. Any modification of the content of the VNFD or the VNF Package shall result in a new VNFD Identifier.
|
defaultLocalizationLanguage | String | 0..1 | Preliminary OpenModelAttribute
| Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time.
|
configurableProperties | VnfConfigurableProperties | 0..1 | Preliminary OpenModelAttribute
| Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing).
|
lifecycleManagementScript | VnfLifecycleManagementScript | 0..* | Preliminary OpenModelAttribute
| Includes a list of events and corresponding management scripts performed for the VNF.
|
logo | String | 0..1 | Preliminary OpenModelAttribute
| File path of the vendor specified logo.
|
guide | String | 0..1 | Preliminary OpenModelAttribute
| UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model.
|
_vdu | Vdu | 1..* | Preliminary OpenModelAttribute
| Virtualisation Deployment Unit.
|
_vnfExtCpd | VnfExtCpd | 1..* | Preliminary OpenModelAttribute
| Describes external interface(s) exposed by this VNF enabling connection with a VL.
|
_deploymentFlavour | VnfDf | 1..* | Preliminary OpenModelAttribute
| Describes specific DF(s) of a VNF with specific requirements for capacity and performance.
|
_vnfIndicator | VnfIndicator | 0..* | Preliminary OpenModelAttribute
| Declares the VNF indicators that are supported by this VNF.
|
_virtualComputeDesc | VirtualComputeDesc | 0..* | Preliminary OpenModelAttribute
| Defines descriptors of virtual compute resources to be used by the VNF.
|
_virtualStorageDesc | VirtualStorageDesc | 0..* | Preliminary OpenModelAttribute
| Defines descriptors of virtual storage resources to be used by the VNF.
|
_vnfReservedCpd | VduCpd | 0..* | Preliminary OpenModelAttribute
| Reserved IP Address for VNF which is not bounded to any specific VNFC, but assigned manually from outside and potentially shared as a floating IP among VNFCs.
|
_elementGroup | VnfdElementGroup | 0..* | Obsolete OpenModelAttribute
| Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management.
|
_swImageDesc | SwImageDesc | 0..* | Preliminary OpenModelAttribute
| Defines descriptors of software images to be used by the VNF. NOTE: This shall be used to describe both the software image loaded on the virtualization container used to realize a VDU and the software images to be stored on VirtualStorage resources (e.g., volumes) attached to a virtualization container.
|
_intVirtualLinkDesc | VnfVirtualLinkDesc | 0..* | Preliminary OpenModelAttribute
| Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP.
|
Vdu
The Virtualisation Deployment Unit (VDU) is a construct supporting the description of the deployment and operational behavior of a VNFC. A VNFC instance created based on the VDU maps to a single virtualisation container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor wants to use the VNFC in mupliple VNFDesc (their product) they can do so, but it will be 'repeated'.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
vduId | Identifier | 1 | Preliminary OpenModelAttribute
| Unique identifier of this Vdu in VNFD.
|
name | String | 1 | Preliminary OpenModelAttribute
| Human readable name of the Vdu.
|
description | String | 1 | Preliminary OpenModelAttribute
| Human readable description of the Vdu.
|
bootOrder | KeyValuePair | 0..* | Preliminary OpenModelAttribute
| Boot order of valid boot devices. "key/name" indicates the the boot index "value" references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created. NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used.
|
nfviConstraint | KeyValuePair | 0..* | Preliminary OpenModelAttribute
| Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment for the VNFC instance that involve additional entities or processes. "key/name" includes "AvailabilityZone", "HostAggregates". NOTE: These are constraints other than stipulating that a VNFC instance has access to a certain resource, as a prerequisite to instantiation. The attributes virtualComputeDesc and virtualStorageDesc define the resources required for instantiation of the VNFC instance.
|
monitoringParameter | MonitoringParameter | 0..* | Preliminary OpenModelAttribute
| Defines the virtualised resources monitoring parameters on VDU level.
|
injectFiles | String | 0..* | Preliminary OpenModelAttribute
| Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process.
|
configurableProperties | VnfcConfigurableProperties | 1 | Preliminary OpenModelAttribute
| Describes the configurable properties of all VNFC instances based on this VDU.
|
bootData | String | 0..1 | Experimental OpenModelAttribute
| Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental
|
_intCpd | VduCpd | 1 | Preliminary OpenModelAttribute
| Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL).
|
_virtualComputeDesc | VirtualComputeDesc | 1..* | PassedByReference Preliminary OpenModelAttribute
| Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.
|
_virtualStorageDesc | VirtualStorageDesc | 0..* | PassedByReference Preliminary OpenModelAttribute
| Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.
|
_swageDesc | SwImageDesc | 0..1 | PassedByReference Preliminary OpenModelAttribute
| Describes the software image which is directly loaded on the virtualisation container realising this Vdu. NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources.
|
_dependOn | Vdu | 0..* | Future OpenModelAttribute
|
|
VduCpd
A VduCpd information element is a type of Cpd and describes network connectivity between a VNFC instance (based on this VDU) and an internal VL.
Parent class: Cpd
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
bitrateRequirement | Number | 0..1 | Preliminary OpenModelAttribute
| Bitrate requirement on this CP.
|
vnicName | String | 0..1 | Preliminary OpenModelAttribute
| Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process.
|
vnicOrder | String | 0..1 | Preliminary OpenModelAttribute
| Describes the order to create the vNIC within the scope of this Vdu.
|
vnicType | VnicType | 0..1 | Preliminary OpenModelAttribute
| Describes the type of the vNIC this CP attaches to.
|
_virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..* | Preliminary OpenModelAttribute
| Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.
|
sriovAntiAffinityGroup | Identifier | 0..1 | Future OpenModelAttribute
| Define the port anti-affinity group ID for each SR-IOV type vNIC. Multiple vNICs in the same anti-affinity group must belong to the same virtual network, and the number of vNICs in the same anti-affinity group cannot exceed two.
|
securityGroups | String | 0..* | Future OpenModelAttribute
| VNFD needs to specify the security group name {security_groups} for each vNic.
|
portSecurityEnabled | Boolean | 0..1 | Future OpenModelAttribute
| VNFD needs to specify whether to enable security group for the vNic.
|
qos | QoS | 0..1 | Future OpenModelAttribute
| Describe the Qos requirements of the VduCpd.
|
_intVirtualLinkDesc | VnfVirtualLinkDesc | 0..1 | Experimental PassedByReference OpenModelAttribute
| Reference(s) of the Virtual Link Descriptor to which this Connection Point Descriptor(s) connects.
|
allowedAddressData | AddressData | 0..* | Preliminary OpenModelAttribute
| For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.
|
cpdId | Identifier | 1 | Preliminary OpenModelAttribute
| Identifier of this Cpd information element.
|
cpdRole | String | 0..1 | Preliminary OpenModelAttribute
| Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS. For example a VNF with a tree flow pattern within the VNF will have legal cpRoles of ROOT and LEAF.
|
description | String | 0..1 | Preliminary OpenModelAttribute
| Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic).
|
cpProtocol | CpProtocolData | 1..* | Preliminary OpenModelAttribute
| Identifies the protocol layering information the CP uses for connectivity purposes and associated information. There shall be one cpProtocol for each layer protocol as indicated by the attribute layerProtocol. Editor's note: the attribute "layerProtocol" still needs further discussion and not included in this table.
|
trunkMode | Boolean | 1 | Preliminary OpenModelAttribute
| Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).
|
layerProtocol | LayerProtocol | 1..* | Experimental OpenModelAttribute
| Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.).
|
VirtualComputeDesc
The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
virtualComputeDescId | Identifier | 1 | Preliminary OpenModelAttribute
| Unique identifier of this VirtualComputeDesc in the VNFD
|
requestAdditionalCapabilities | RequestedAdditionalCapabilityData | 0..* | Obsolete OpenModelAttribute
| Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities.
|
computeRequirements | KeyValuePair | 0..* | Preliminary OpenModelAttribute
| Specifies compute requirements.
|
virtualMemory | VirtualMemoryData | 1 | Preliminary OpenModelAttribute
| The virtual memory of the virtualised compute.
|
virtualCpu | VirtualCpuData | 1 | Preliminary OpenModelAttribute
| The virtual CPU(s) of the virtualised compute.
|
_logicalNodeRequirements | LogicalNodeRequirements | 0..* | Experimental OpenModelAttribute
| The associated logical node requirements.
|
virtualDisk | BlockStorageData | 0..* | Experimental OpenModelAttribute
| The local or ephemeral disk(s) of the virtualised compute.
|
VirtualStorageDesc
The VirtualStorageDesc information element supports the specifications of requirements related to persistent virtual storage resources. Ephemeral virtual storage is specified in VirtualComputeDesc information element.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | Preliminary OpenModelAttribute
| Unique identifier of this VirtualStorageDesc in the VNFD.
|
typeOfStorage | String | 1 | Experimental OpenModelAttribute
| Type of virtualised storage resource (BLOCK, OBJECT, FILE).
|
sizeOfStorage | Number | 1 | Preliminary OpenModelAttribute
| Size of virtualised storage resource (e.g. size of volume, in GB).
|
blockStorageData | BlockStorageData | 0..1 | Experimental OpenModelAttribute
| Specifies the details of block storage. It shall be present when the "typeOfStorage" attribute is set to "BLOCK". It shall be absent otherwise.
|
objectStorageData | ObjectStorageData | 0..1 | Experimental OpenModelAttribute
| Specifies the details of object storage. It shall be present when the "typeOfStorage" attribute is set to "OBJECT". It shall be absent
|
fileStorageData | FileStorageData | 0..1 | Experimental OpenModelAttribute
| Specifies the details of file storage. It shall be present when the "typeOfStorage" attribute is set to "FILE". It shall be absent otherwise.
|
multiAttach | Boolean | 0..1 | Future OpenModelAttribute
| Indicating whether a vDisk is a shared volume in VNFD.
|
storageQos | StorageQos | 0..1 | Future OpenModelAttribute
| Describe storage Qos requirements.
|
volumeType | VolumeType | 0..1 | Future OpenModelAttribute
| Describe volume type.
|
VnfVirtualLinkDesc
Represents the type of network connectivity mandated by the VNF vendor between two or more Connection Points which includes at least one Internal Connection Point.
Parent class: VirtualLinkDesc
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
monitoringParameter | MonitoringParameter | 0..* | OpenModelAttribute
Experimental | Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM.
|
_virtualLinkDescFlavour | VirtualLinkDescFlavour | 1..* | OpenModelAttribute
Preliminary | Describes a specific flavour of the VL with specific bitrate requirements.
|
virtualLinkDescId | Identifier | 1 | OpenModelAttribute
Preliminary | Uniquely identifies a VLD in the parent descriptor. For VnfVirtualLinkDesc, the parent descriptor is the VNFD. For NsVirtualLinkDesc, the parent descriptor is the NSD. Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions.
|
connectivityType | ConnectivityType | 1 | OpenModelAttribute
Preliminary | Specifies the protocol exposed by a VL and the flow pattern supported by the VL.
|
description | String | 0..1 | OpenModelAttribute
Preliminary | Provides human-readable information on the purpose of the VL (e.g. control plane traffic).
|
VnfExtCpd
A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL.
When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
_virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..* | OpenModelAttribute
Preliminary | Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute of the referenced intCpd applies.
|
_intCpd | VduCpd | 0..1 | PassedByReference OpenModelAttribute
Preliminary | A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements.
|
_intVirtualLinkDesc | VnfVirtualLinkDesc | 0..1 | PassedByReference OpenModelAttribute
Experimental |
|
SwImageDesc
The SwImageDesc information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. Storage not necessarily related to the compute, may be Network Attached Storage (NAS)
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Preliminary | The identifier of this software image.
|
name | String | 1 | OpenModelAttribute
Preliminary | The name of this software image.
|
version | Version | 1 | OpenModelAttribute
Preliminary | The version of this software image.
|
checksum | String | 1 | OpenModelAttribute
Preliminary | The checksum of the software image file.
|
containerFormat | String | 1 | OpenModelAttribute
Preliminary | The container format describes the container file format in which software image is provided.
|
diskFormat | String | 1 | OpenModelAttribute
Preliminary | The disk format of a software image is the format of the underlying disk image.
|
minRam | Number | 0..1 | OpenModelAttribute
Preliminary | The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam.
|
minDisk | Number | 1 | OpenModelAttribute
Preliminary | The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk.
|
size | Number | 1 | OpenModelAttribute
Preliminary | The size of the software image.
|
operatingSystem | String | 0..1 | OpenModelAttribute
Preliminary | Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used.
|
supportedVirtualisationEnvironment | String | 0..* | OpenModelAttribute
Preliminary | Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image.
|
_swImage | SwImage | 1 | PassedByReference OpenModelAttribute
Preliminary | This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL
|
VduLevel
The VduLevel information element indicates for a given VDU in a given level the number of instances to deploy.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
numberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary | Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta.
|
_vduId | Vdu | 1 | PassedByReference OpenModelAttribute
Experimental | Uniquely identifies a VDU.
|
VduProfile
The VduProfile describes additional instantiation data for a given VDU used in a DF.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
minNumberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary | Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater.
|
maxNumberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary | Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater.
|
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..* | OpenModelAttribute
Preliminary | Specifies affinity or anti-affinity rules applicable between the virtualization containers (e.g. virtual machines) to be created based on this VDU. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes (e.g. "Affinity with the scope resource zone and anti-affinity with the scope NFVI node") are applicable to the virtualization containers (e.g. virtual machines) to be created based on this VDU. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes (e.g. "Affinity with the scope resource zone and anti-affinity with the scope NFVI node") are applicable to the virtualization containers (e.g. virtual machines) to be created based on this VDU.
|
affinityOrAntiAffinityGroupId | Identifier | 0..* | OpenModelAttribute
Preliminary | Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to. NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group.
|
watchdog | String | 0..1 | OpenModelAttribute
Preliminary | Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc.
|
vmBootUpTimeOut | Integer | 0..1 | OpenModelAttribute
Preliminary | Timeout value for the VNFM to wait before the successful booting up of the VDU.
|
securityGroups | String | 0..* | OpenModelAttribute
Future | VNFD needs to specify the security group name {security_groups} for each VDU.
|
flavorExtraSpecs | KeyValuePair | 0..* | OpenModelAttribute
Future | Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate ).
|
_vduId | Vdu | 1 | PassedByReference OpenModelAttribute
Preliminary |
|
VirtualLinkDescFlavour
The VirtualLinkDescFlavour describes additional instantiation data for a given internal VL used in a DF.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
qos | VnfQoS | 0..1 | OpenModelAttribute
Preliminary | QoS of the VL.
|
flavourId | Identifier | 1 | OpenModelAttribute
Preliminary | Identifies a flavour within a VnfVirtualLinkDesc.
|
VirtualLinkProfile
The VirtualLinkProfile describes additional instantiation data for a given VL used in a DF.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
virtualLinkProfileId | Identifier | 1 | OpenModelAttribute
Experimental | Uniquely identifies this VirtualLinkProfile class
|
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..* | OpenModelAttribute
Preliminary | Specifies affinity or anti-affinity rules applicable between the VLs based on this VnfVirtualLinkDesc. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes are applicable to the VLs based on this VnfVirtualLinkDesc.
|
maxBitRateRequirements | LinkBitrateRequirements | 1 | OpenModelAttribute
Preliminary | Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
minBitRateRequirements | LinkBitrateRequirements | 1 | OpenModelAttribute
Preliminary | Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
_flavourId | VirtualLinkDescFlavour | 1 | OpenModelAttribute
Preliminary | Identifies a flavour within the VnfVirtualLinkDesc.
|
_affinityOrAntiAffinityGroupId | AffinityOrAntiAffinityGroup | 0..* | PassedByReference OpenModelAttribute
Experimental | Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group.
|
_vnfVirtualLinkDescId | VnfVirtualLinkDesc | 1 | PassedByReference OpenModelAttribute
Preliminary | Uniquely references a VLD.
|
virtualLinkProtocolData | VirtualLinkProtocolData | 0..* | OpenModelAttribute
Experimental | Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no protocol data needs to be specified.
|
VirtualNetworkInterfaceRequirements
This class specifies requirements on a virtual network interface.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
name | String | 0..1 | OpenModelAttribute
Preliminary | Provides a human readable name for the requirement.
|
description | String | 0..1 | OpenModelAttribute
Preliminary | Provides a human readable description of the requirement.
|
supportMandatory | Boolean | 1 | OpenModelAttribute
Preliminary | Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
|
networkInterfaceRequirements | KeyValuePair | 0..* | OpenModelAttribute
Preliminary | The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements
|
nicIoRequirements | LogicalNodeRequirements | 0..1 | PassedByReference OpenModelAttribute
Experimental | This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD.
|
VnfDf
This class specifies requirements on a virtual network interface.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
name | String | 0..1 | OpenModelAttribute
Preliminary | Provides a human readable name for the requirement.
|
description | String | 0..1 | OpenModelAttribute
Preliminary | Provides a human readable description of the requirement.
|
supportMandatory | Boolean | 1 | OpenModelAttribute
Preliminary | Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
|
networkInterfaceRequirements | KeyValuePair | 0..* | OpenModelAttribute
Preliminary | The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements
|
nicIoRequirements | LogicalNodeRequirements | 0..1 | PassedByReference OpenModelAttribute
Experimental | This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD.
|
LogicalNodeRequirements
This information element describes compute, memory and I/O requirements that are to be associated with the logical node of infrastructure. The logical node requirements are a sub-component of the VDU level requirements. As an example for illustration purposes, a logical node correlates to the concept of a NUMA cell in libvirt terminology.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Experimental | Identifies this set of logical node requirements.
|
logicalNodeRequirementDetail | KeyValuePair | 1..* | OpenModelAttribute
Experimental | The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements. This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node.
|
VnfIndicator
The VnfIndicator information element defines the indicator the VNF supports.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Preliminary | Unique identifier.
|
name | String | 0..1 | OpenModelAttribute
Preliminary | The human readable name of the VnfIndicator.
|
indicatorValue | String | 1..* | OpenModelAttribute
Preliminary | Defines the allowed values or value ranges of this indicator.
|
source | VnfSource | 1 | OpenModelAttribute
Preliminary | Describe the source of the indicator. This tells the consumer where to send the subscription request.
|
ScalingAspect
The ScalingAspect class describes the details of an aspect used for horizontal scaling.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
id | String | 1 | OpenModelAttribute
Experimental | Unique identifier of this aspect in the VNFD.
|
name | String | 1 | OpenModelAttribute
Experimental | Human readable name of the aspect.
|
description | String | 1 | OpenModelAttribute
Experimental | Human readable description of the aspect.
|
InstantiationLevel
The InstantiationLevel class describes a given level of resources to be instantiated within a DF in term of the number of VNFC instances to be created from each VDU. All the VDUs referenced in the level shall be part of the corresponding DF and their number shall be within the range (min/max) for this DF.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Stereotypes | Description |
levelId | Identifier | 1 | OpenModelAttribute
Preliminary | Uniquely identifies a level with the DF.
|
description | String | 1 | OpenModelAttribute
Preliminary | Human readable description of the level.
|
scaleInfo | ScaleInfo | 0..* | OpenModelAttribute
Preliminary | Represents for each aspect the scale level that corresponds to this instantiation level. scaleInfo shall be present if the VNF supports scaling.
|
_vduLevel | VduLevel | 1..* | OpenModelAttribute
Preliminary | Indicates the number of instance of this VDU to deploy for this level.
|
virtualLinkBitRateLevel | VirtualLinkBitRateLevel | 0..* | OpenModelAttribute
Preliminary | Specifies bitrate requirements applicable to virtual links created from particular virtual link descriptors for this level. NOTE: If not present, it is assumed that the bitrate requirements can be derived from those specified in the VduCpd instances applicable to the internal VL. If present in both the InstantiationLevel and the VduCpd instances applicable to the internal VL, the highest value takes precedence.
|
Datatypes from Vnf Sub-Model
BlockStorageData
Specifies the details of the block storage resource.
Applied stereotypes:
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
sizeOfStorage | Number | 1 | RW | OpenModelAttribute
Experimental | Size of virtualised storage resource in GB.
|
vduStorageRequirements | KeyValuePair | 0..* | RW | OpenModelAttribute
Experimental | An array of key-value pairs that articulate the storage deployment requirements.
|
rdmaEnabled | Boolean | 0..1 | RW | OpenModelAttribute
Obsolete | Indicates if the storage supports rdma.
|
swImageDesc | SwImageDesc | 0..1 | RW | OpenModelAttribute
Experimental | Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks.
|
FileStorageData
The FileStorageData information element specifies the details of file storage resource.
Applied stereotypes:
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
sizeOfStorage | Number | 1 | RW | OpenModelAttribute
Experimental | Size of virtualised storage resource in GB.
|
fileSystemProtocol | String | 1 | RW | OpenModelAttribute
Experimental | The shared file system protocol (e.g. NFS, CIFS).
|
intVirtualLinkDesc |
| 1 | RW | PassedByReference OpenModelAttribute
Experimental | Reference of the internal VLD which this file storage connects to. The attached VDUs shall connect to the same internal VLD.
|
LogicalNodeRequirements
This information element describes compute, memory and I/O requirements that are to be associated with the logical node of infrastructure. The logical node requirements are a sub-component of the VDU level requirements. As an example for illustration purposes, a logical node correlates to the concept of a NUMA cell in libvirt terminology.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
logicalNodeRequirement | KeyValuePair | 0..* | RW | OpenModelAttribute
Preliminary | The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements. This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node.
|
MonitoringParameter
Specifies the virtualized resource related performance metric to be tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects the values of performance metrics identified by this information element from the VIM(s) using one or more locally initiated PM Jobs. These values can be used as inputs to auto-scaling rules.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
id | Identifier | 1 | RW | OpenModelAttribute
Preliminary | Unique identifier of the monitoring parameter.
|
name | String | 0..1 | RW | OpenModelAttribute
Preliminary | Human readable name of the monitoring parameter.
|
performanceMetric | String | 1 | RW | OpenModelAttribute
Preliminary | Identifies the virtualized resource performance metric.
|
collectionPeriod | CollectionPeriod | 0..1 | RW | OpenModelAttribute
Preliminary | An attribute that describes the recommended periodicity at which to collect the performance information. VNFM determines if this parameter is considered. The vendor may provide this information as a guidance for creating PmJobs if needed. NOTE: The MANO or NFVI may not support the recommended collectionPeriod based on their functionalities, and can reject the requests based on the recommended collectionPeriod in this case.
|
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..1 | RW | OpenModelAttribute
Future |
|
ObjectStorageData
The ObjectStorageData information element specifies the details of object storage resource.
Applied stereotypes:
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
maxSizeOfStorage | Number | 0..1 | RW | OpenModelAttribute
Experimental | Max size of virtualised storage resource in GB.
|
RequestedAdditionalCapabilityData
This information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks.
Applied stereotypes:
- Obsolete
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
supportMandatory | Boolean | 1 | RW | OpenModelAttribute
Obsolete | Indicates whether the requested additional capability is mandatory for successful operation.
|
requestedAdditionalCapabilityName | String | 1 | RW | OpenModelAttribute
Obsolete | Identifies a requested additional capability for the VDU.
|
minRequestedAdditionalCapabilityVersion | String | 0..1 | RW | OpenModelAttribute
Obsolete | Identifies the minimum version of the requested additional capability.
|
preferredRequestedAdditionalCapabilityVersion | String | 0..1 | RW | OpenModelAttribute
Obsolete | Identifies the preferred version of the requested additional capability.
|
targetPerformanceParameters | KeyValuePair | 1..* | RW | OpenModelAttribute
Obsolete | Identifies specific attributes, dependent on the requested additional capability type.
|
ScaleInfo
The ScaleInfo information element represents a scale level for a particular scaling aspect.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
aspectId | ScalingAspect | 1 | RW | PassedByReference OpenModelAttribute
Preliminary | Reference to the scaling aspect.
|
scaleLevel | Integer | 1 | RW | OpenModelAttribute
Preliminary | The scale level, greater than or equal to 0
|
VirtualCpuData
The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
cpuArchitecture | String | 0..1 | RW | OpenModelAttribute
Preliminary | CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested.
|
numVirtualCpu | Integer | 1 | RW | OpenModelAttribute
Preliminary | Number of virtual CPUs.
|
virtualCpuClock | Number | 0..1 | RW | OpenModelAttribute
Preliminary | Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested.
|
virtualCpuOversubscriptionPolicy | String | 0..1 | RW | OpenModelAttribute
Obsolete | The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested.
|
vduCpuRequirements | KeyValuePair | 0..* | RW | OpenModelAttribute
Preliminary | Array of key-value pair requirements on the Compute (CPU) for the VDU.
|
virtualCpuPinning | VirtualCpuPinningData | 0..1 | RW | OpenModelAttribute
Obsolete | The virtual CPU pinning configuration for the virtualised compute resource.
|
VirtualCpuPinningData
The VirtualCpuPinningData information element supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource.
Applied stereotypes:
- Obsolete
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
virtualCpuPinningPolicy | PinningPolicy | 0..1 | RW | OpenModelAttribute
Obsolete | The policy can take values of "static" or "dynamic". In case of "static" the virtual CPU cores are requested to be allocated to logical CPU cores according to the rules defined in virtualCpuPinningRules. In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements).
|
virtualCpuPinningRule | invalid | 0..1 | RW | OpenModelAttribute
Obsolete | A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy.
|
VirtualLinkBitRateLevel
The VirtualLinkBitRateLevel information element specifies bitrate requirements applicable to a virtual link instantiated from a particular VnfVirtualLinkDesc.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
VirtualLinkProtocolData
The VirtualLinkProtocolData describes the protocol layer and associated protocol data for a virtual link
Applied stereotypes:
- Experimental
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
associatedLayerProtocol | LayerProtocol | 1 | RW | OpenModelAttribute
Experimental | One of the values of the attribute layerProtocol of the ConnectivityType IE.
|
l2ProtocolData | L2ProtocolData | 0..1 | RW | OpenModelAttribute
Experimental | Specifies the L2 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
|
l3ProtocolData | L3ProtocolData | 0..1 | RW | OpenModelAttribute
Experimental | Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
|
VirtualMemoryData
The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
virtualMemSize | Number | 1 | RW | OpenModelAttribute
Preliminary | Amount of virtual Memory (e.g. in MB).
|
virtualMemOversubscriptionPolicy | String | 0..1 | RW | OpenModelAttribute
Preliminary Obsolete | The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested.
|
vduMemRequirements | KeyValuePair | 0..* | RW | OpenModelAttribute
Preliminary | Array of key-value pair requirements on the memory for the VDU.
|
numaEnabled | Boolean | 0..1 | RW | OpenModelAttribute
Obsolete | It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested.
|
VnfConfigurableProperties
This datatype defines the configurable properties of a VNF (e.g. related to auto scaling and auto healing). For a VNF instance, the value of these properties can be modified by the VNFM
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
isAutoscaleEnabled | Boolean | 0..1 | RW | OpenModelAttribute
Preliminary | It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported.
|
isAutohealEnabled | Boolean | 0..1 | RW | OpenModelAttribute
Preliminary | It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported.
|
additionalConfigurableProperty | String | 0..* | RW | OpenModelAttribute
Preliminary |
|
VnfIndicatorData
The VnfIndicatorData datatype identifies a VNF indicator in a VNFD.
Applied stereotypes:
- Reference
- reference: IFA011 v2.5.1
- Experimental
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
vnfdId | invalid | 1 | RW | OpenModelAttribute
| Identifies a VNFD.
|
vnfIndicator | invalid | 1 | RW | OpenModelAttribute
| Identifies a VNF indicator within the VNFD.
|
VnfInfoModifiableAttributes
This datatype defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
extension | invalid | 0..* | RW | OpenModelAttribute
Experimental | "Extension" attributes of VnfInfo that are writeable.
|
metadata | invalid | 0..* | RW | OpenModelAttribute
Experimental | Metadata" attributes of VnfInfo that are writeable
|
VnfLcmOperationsConfiguration - Note: IFA011 contains many attributes. Are we not using this?
Applied stereotypes:
- Reference
- reference: IFA011 v2.5.1
- Experimental
VnfLifecycleManagementScript
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
event | LcmEvent | 0..* | RW | OpenModelAttribute
Preliminary | Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point.
|
icmTransitionEvent | String | 0..* | RW | OpenModelAttribute
Preliminary | Describes the transition VNF lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. NOTE: At least one of these two attributes shall be included.
|
script | String | 1 | RW | OpenModelAttribute
Preliminary | Information to locate a VNF LCM script (e.g. written in a DSL as specified in requirement VNF_PACK.LCM.001) triggered to react to one of the events listed in the event attribute.
|
scriptDsl | String | 1 | RW | OpenModelAttribute
Preliminary | Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc.
|
scriptInput | KeyValuePair | 0..* | RW | OpenModelAttribute
Preliminary | Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. NOTE: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change.
|
VnfQoS - Note: This inherits all the attributes from Common QoS
The QoS as applied to the vnf.
Applied stereotypes:
- Experimental
VnfcConfigurableProperties
This datatype defines the configurable properties of a VNFC. For a VNFC instance, the value of these properties can be modified through the VNFM.
Applied stereotypes:
- Preliminary
- Reference
- reference: IFA011 v2.5.1
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
additionalVnfcConfigurableProperty | String | 0..* | RW | OpenModelAttribute
Preliminary | It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation.
|