The following output contains
- R2 Clean with appropriate Classes changed to Datatypes
- R3 Vnf and Vnfc Instance Classes
- Discussed Classes and Attributes designated as Obsolete
- Items not updated from R2 are designated as Preliminary
- New Items designated as Experimental
Diagrams
ONAP Vnfd - Topology View
ONAP Vnfd View
VNF Instance
Vnf Deployment Flavor
VNF Datatypes
Clases
AffinityOrAntiAffinityGroup
The AffinityOrAntiAffinityGroup class describes the affinity or anti-affinity relationship.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
groupId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifies an affinity or anti-affinity group to which the affinity or anti-affinity rule applies.
|
type | RuleType | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies whether the rule is an affinity rule or an anti-affinity rule.
|
scope | RuleScope | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies the scope of the rule.
|
BaseConfigGroup
Every VNF contains a BaseConfigGroup. BaseConfigGroup may set Access Control Lists (ACL's) and establish security groups and server groups. BaseConfigGroup reates/establishs storage for the VM's (OpenStack Cinder). BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very simple VNF may only have a BaseConfig VNFElementGroup.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Cpd
A Cpd information element describes network connectivity to a compute resource or a VL. This is an abstract class used as parent for the various Cpd classes.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
cpdId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifier of this Cpd information element.
|
cpRole | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic).
|
cpProtocol | CpProtocolData | 1..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).
|
allowedAddressData | AddressData | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.
|
DeploymentGroup
DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF. I can have a small, medium, large deployment configuration.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
HomingGroup
Homing selects what cloud selection strategy will be used. HomingGroup is used to determine where VNF's within a given group are placed with respect to a service component. Homing strategy is as follows: Colocation - members of the group share the same cloud region (VIM Domain) isolation - members of the group do not share the same cloud region.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
homingStrategy | HomingStrategy | 1 | OpenModelAttribute
OnapModelLifecycle
| The homing strategy can be one of the following: Exclusivity - Resources within the cloud region are exclusive to the group Inclusively - Resources are co-located in the same cloud-region. Diversity - Resources are geo-diverse ( cannot be co-located).
|
vnfdMembers | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
|
|
vnfdElementGroupId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this group in the VNFD.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the group.
|
_vdu | Vdu | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
_vnfVirtualLinkdesc | VnfVirtualLinkDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
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:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
levelId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Uniquely identifies a level with the DF.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the level.
|
scaleInfo | ScaleInfo | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 OnapModelLifecycle
| Indicates the number of instance of this VDU to deploy for this level.
|
virtualLinkBitRateLevel | VirtualLinkBitRateLevel | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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.
|
PlacementGroup
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
placementStrategy | PlacementStrategy | 1 | OpenModelAttribute
OnapModelLifecycle
|
|
strategScope | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
|
|
vnfdElementGroupId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this group in the VNFD.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the group.
|
_vdu | Vdu | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
_vnfVirtualLinkdesc | VnfVirtualLinkDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
ScalingAspect
The ScalingAspect class describes the details of an aspect used for horizontal scaling.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
ScalingGroup
A ScalingGroup determines which VNFC's (VDU's) are scaled together based on demand.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfcMembers | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
|
|
vnfdElementGroupId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this group in the VNFD.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the group.
|
_vdu | Vdu | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
_vnfVirtualLinkdesc | VnfVirtualLinkDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
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) References: tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The identifier of this software image.
|
name | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The name of this software image.
|
version | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The version of this software image.
|
checksum | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The checksum of the software image file.
|
containerFormat | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The container format describes the container file format in which software image is provided.
|
diskFormat | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The disk format of a software image is the format of the underlying disk image.
|
minRam | Number | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 OnapModelLifecycle
| 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 OnapModelLifecycle
| The size of the software image.
|
operatingSystem | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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. support:
|
supportedVirtualisationEnvironment | String | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image.
|
swImage | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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.
|
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'. References: tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
vduId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this Vdu in VNFD.
|
name | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable name of the Vdu.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the Vdu.
|
bootOrder | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Boot order of valid boot devices. NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used.
|
nfviConstraint | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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. 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..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Defines the virtualised resources monitoring parameters on VDU level.
|
injectFiles | String | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process.
|
configurableProperties | VnfcConfigurableProperties | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describes the configurable properties of all VNFC instances based on this VDU.
|
_vduCpd | VduCpd | 1 | OpenModelAttribute
OnapModelLifecycle
| Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL).
|
_virtualComputeDesc | VirtualComputeDesc | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.
|
_virtualStorageDesc | VirtualStorageDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
| Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.
|
_swImageDesc | SwImageDesc | 0..1 | OpenModelAttribute
OnapModelLifecycle
| 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.
|
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.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
bitrateRequirement | Number | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Bitrate requirement on this CP.
|
vnicName | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describes the order to create the vNIC within the scope of this Vdu.
|
vnicType | VnicType | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describes the type of the vNIC this CP attaches to.
|
_virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..* | OpenModelAttribute
OnapModelLifecycle
| Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.
|
cpdId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifier of this Cpd information element.
|
cpRole | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic).
|
cpProtocol | CpProtocolData | 1..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).
|
allowedAddressData | AddressData | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.
|
VduLevel
The VduLevel information element indicates for a given VDU in a given level the number of instances to deploy.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
vduId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Uniquely identifies a VDU.
|
numberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta.
|
VduProfile
The VduProfile describes additional instantiation data for a given VDU used in a DF.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
vudId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Uniquely identifies a VDU.
|
minNumberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.
|
maxNumberOfInstances | Integer | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.
|
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) to be created based on this VDU.
|
affinityOrAntiAffinityGroupId | Identifier | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 OnapModelLifecycle
| 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 OnapModelLifecycle
| Timeout value for the VNFM to wait before the successful booting up of the VDU.
|
VirtualComputeDesc
The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
virtualComputeDescId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this VirtualComputeDesc in the VNFD
|
logicalNode | LogicalNodeData | 1..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| The logical Node requirements.
|
requestAdditionalCapabilities | RequestedAdditionalCapabilityData | 0..* | Obsolete OpenModelAttribute
OnapModelLifecycle
| Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities.
|
computeRequirements | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies compute requirements.
|
virtualMemory | VirtualMemoryData | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The virtual memory of the virtualised compute.
|
virtualCpu | VirtualCpuData | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The virtual CPU(s) of the virtualised compute.
|
VirtualLinkDescFlavour
The VirtualLinkDescFlavour describes additional instantiation data for a given internal VL used in a DF.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
qos | QoS | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| QoS of the VL.
|
flavourId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifies a flavour within a VnfVirtualLinkDesc.
|
VirtualLinkProfile
The VirtualLinkProfile describes additional instantiation data for a given VL used in a DF.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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.
|
affinityOrAntiAffinityGroupId | Identifier | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifier(s) of the affinity or anti-affinity group(s) the VnfVirtualLinkDesc belongs to. NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VnfVirtualLinkDesc and the VL(s) using other VnfVirtualLinkDesc(s) in the same group.
|
maxBitRateRequirements | LinkBitrateRequirements | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
minBitRateRequirements | LinkBitrateRequirements | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
initiationParameters | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies initiation parameters for the virtual link.
|
networkType | NetworkType | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Type of the network
|
dhcpEnabled | Boolean | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise.
|
vlanTransparent | Boolean | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Indicating whether "VLAN Transparent Mode" is supported. Default is "FALSE" if not specified otherwise.
|
_virtualLinkDescFlavour | VirtualLinkDescFlavour | 1 | OpenModelAttribute
OnapModelLifecycle
| Identifies a flavour within the VnfVirtualLinkDesc.
|
_virtualLinkDesc | VnfVirtualLinkDesc | 1 | OpenModelAttribute
OnapModelLifecycle
| Uniquely identifies a Vnf VLD.
|
VirtualNetworkInterfaceRequirements
This class specifies requirements on a virtual network interface.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
name | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provides a human readable name for the requirement.
|
description | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provides a human readable description of the requirement.
|
supportMandatory | Boolean | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
|
networkInterfaceRequirements | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements
|
nicIoRequirements | LogicalNodeData | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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.
|
VirtualStorageDesc
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this VirtualStorageDesc in the VNFD.
|
typeOfStorage | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Type of virtualised storage resource (e.g. volume, object).
|
sizeOfStorage | Number | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Size of virtualised storage resource (e.g. size of volume, in GB).
|
vduStorageRequirements | KeyValuePair | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| An array of key-value pairs that articulate the storage deployment requirements.
|
rdmaEnabled | Boolean | 0..1 | Obsolete OpenModelAttribute
OnapModelLifecycle
| Indicate if the storage support RDMA.
|
swImageDesc | Identifier | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc.
|
Vnf
An implementation of an NF that can be deployed on a Network Function Virtualisation Infrastructure (NFVI).
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
_vnfExtCp | VnfExtCp | 1..* | OpenModelAttribute
OnapModelLifecycle
| External CP of the VNF.
|
VnfDf
The VnfDf describes a specific deployment version of a VNF.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
flavorId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifier of this DF within the VNFD.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the DF.
|
_virtuaLlinkProfile | VirtualLinkProfile | 0..* | OpenModelAttribute
OnapModelLifecycle
| Defines the internal VLD along with additional data which is used in this DF. NOTE 1: This allows for different VNF internal topologies between DFs. NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to.
|
_instantiationLevel | InstantiationLevel | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes the various levels of resources that can be used to instantiate the VNF using this flavour. Examples: Small, Medium, Large. If there is only one "instantiationLevel" entry, it shall be treated as the default instantiation level for this DF.
|
_affinityOrAntiAffinityGroup | AffinityOrAntiAffinityGroup | 0..* | OpenModelAttribute
OnapModelLifecycle
| Specifies affinity or anti-affinity relationship applicable between the virtualisation containers (e.g. virtual machines) to be created using different VDUs or internal VLs to be created using different VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group. NOTE: In the present specification, including either VDU(s) or VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is supported. Extension to support including both VDU(s) and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is left for future specification.
|
_scalingAspect | ScalingAspect | 0..* | OpenModelAttribute
OnapModelLifecycle
| The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling.
|
_vduProfile | VduProfile | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes additional instantiation data for the VDUs used in this flavor.
|
_placementGroup | PlacementGroup | 0..* | OpenModelAttribute
OnapModelLifecycle
| Determine where VNFC's (VDU's) are placed with respect to the VNF
|
_baseConfigGroup | BaseConfigGroup | 1 | OpenModelAttribute
OnapModelLifecycle
| BaseConfigGroup may set Access Control Lists (ACL's) and establish security groups and server groups. BaseConfigGroup creates/establishs storage for the VM's (OpenStack Cinder). BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS (Maintenance & Surveillance) established.
|
_deploymentGroup | DeploymentGroup | 0..* | OpenModelAttribute
OnapModelLifecycle
| DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF.
|
_scalinggroup | ScalingGroup | 0..* | OpenModelAttribute
OnapModelLifecycle
| Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together.
|
VnfExtCp
Describes an external CP exposed by a VNF.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
VnfExtCpd
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
intCpd | Identifier | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Reference to the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, exposed as external CPs defined by this external CPD.
|
_virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..* | OpenModelAttribute
OnapModelLifecycle
| 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.
|
_intVirtualLinkDesc | VnfVirtualLinkDesc | 0..1 | OpenModelAttribute
OnapModelLifecycle
| Reference to the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. Either intVirtualLinkDesc or intCpd shall be present.
|
_vduCpd | VduCpd | 0..1 | OpenModelAttribute
OnapModelLifecycle
|
|
VnfIndicator
The VnfIndicator information element defines the indicator the VNF supports.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier.
|
name | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| The human readable name of the VnfIndicator.
|
indicatorValue | String | 1..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Defines the allowed values or value ranges of this indicator.
|
source | VnfSource | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describe the source of the indicator. This tells the consumer where to send the subscription request.
|
VnfInstance
An implementation of an NF that can be deployed on a Network Function Virtualisation Infrastructure (NFVI).
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfInstanceId | Identifier | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | identifier of the VNF instance
|
vnfInstanceName | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | name of the VNF instance
|
vnfInstanceNameAlt | String | 0..1 | OpenModelAttribute
OnapModelLifecycle
Experimental | alternative name of the VNF instance
|
vnfProductName | String | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| name to identify the VNF Product, invariant for the VNF Product lifetime
|
description | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| description of the VNF instance
|
vnfProvider | invalid | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| provider of the VNF model
|
vnfdId | Identifier | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| identifier of the VNF model
|
vnfdVersion | String | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| version of the VNF model
|
vnfSoftwareVersion | String | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package
|
onboardedVnfPkgInfoId | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | identifier of the specific VNF package on which the VNF instance is based
|
availabilityZone | invalid | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| availability zone information of the VNF instance
|
provStatus | ProvStatus | 0..1 | OpenModelAttribute
OnapModelLifecycle
Experimental | provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED
|
operationalStatus | OperationalStatus | 0..1 | OpenModelAttribute
OnapModelLifecycle
Experimental | indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
|
instantiationState | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | whether the VNF instance is instantiated
|
oamlpv4Address | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| oam ip address, ipv4
|
oamlpv6Address | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| oam ip address, ipv6
|
instantiatedVnfInfo | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| information specific to an instantiated VNF instance, e.g., vm information
|
inMaint | Boolean | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc.
|
isClosedLoopDisabled | Boolean | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| whether closed loop function is enabled
|
encryptedAccessFlag | Boolean | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| whether this VNF is accessed using SSH
|
vnfConfigurableProperty | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| indicator for whether autoHeal and autoScale is enabled
|
nfNamingCode | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | String assigned to this model used for naming purpose.
|
vnfNamingPolicyId | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Identifier of the policy which has the naming logic for this VNF instance
|
vnfHomingPolicyId | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Identifier of the policy which provides homing conditions.
|
nfType | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Generic description of the type of network function
|
nfFunction | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | English description of network function that the specific VNF deployment is providing.
|
nfRole | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Role in the network this model will be providing
|
closedLoopStatus | closedLoopStatus | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Whether closed loop capabilities are enabled for this or not.
|
_nfc (vnfcinstance) | VnfcInstance | 1..* | OpenModelAttribute
OnapModelLifecycle
| Relatonship to the NF components that are part of this VNF.
|
_vnfd | Vnfd | 1 | OpenModelAttribute
OnapModelLifecycle
| Relatinship to the VNF descriptor
|
vnfvirtuallink | VnfVirtualLink | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
VnfVirtualLink
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
VnfVirtualLinkDesc
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
virtualLinkDescId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this internal VLD in VNFD.
|
connectivityType | ConnectivityType | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
|
|
testAccess | String | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints).
|
description | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provides human-readable information on the purpose of the VL (e.g. control plane traffic).
|
monitoringParameter | MonitoringParameter | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Defines the virtualised resources monitoring parameters on VLD level.
|
_virtuaLlinkDescFlavour | VirtualLinkDescFlavour | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes a specific flavour of the VL with specific bitrate requirements.
|
VnfcCp
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
VnfcInstance
An internal component of a VNF providing a VNF Provider a defined sub-set of that VNF's functionality, with the main characteristic that a single instance of this component maps 1:1 against a single Virtualisation Container.
Applied stereotypes:
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
- Experimental
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfcInstanceId | Identifier | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | identifier of the NFC instance
|
nfcNamingCode | String | 0..1 | OpenModelAttribute
OnapModelLifecycle
Experimental | short code of the NFC instance
|
description | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| description of the NFC instance
|
vdudId | Identifier | 1 | OpenModelAttribute
Faulty OnapModelLifecycle
| identifier of the model of the NFC instance
|
l3InterfaceIpv4AddressList | invalid | 0..* | OpenModelAttribute
Faulty OnapModelLifecycle
| layer-3 interface addresses, ipv4
|
l3InterfaceIpv6AddressList | invalid | 0..* | OpenModelAttribute
Faulty OnapModelLifecycle
| layer-3 interface addresses, ipv6
|
vnfcState | invalid | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| operating status of the VM valid value example: STARTED (POWER_ON), STOPPED (POWER_OFF)
|
provStatus | ProvStatus | 0..1 | OpenModelAttribute
OnapModelLifecycle
Experimental | provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED
|
inMaint | Boolean | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc.
|
isClosedLoopDisabled | Boolean | 0..1 | OpenModelAttribute
Faulty OnapModelLifecycle
| whether closed loop function is enabled
|
vnfcInstanceName | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | An intelligent or human readable name of the vnfc instance
|
_vnfcCp | VnfcCp | 1..* | OpenModelAttribute
OnapModelLifecycle
| Reference to the connection points of the vnfc
|
vnfcNamingPolicyId | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Identifier of the policy which has the naming logic for this VNFC instance
|
vnfcInstanceNameAlter | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Additional intelligent or human readable name of the vnfc instance
|
nfcFunction | String | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | English description of network function component that the specific VNFC deployment is providing.
|
operationalStatus | OperationalStatus | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
|
instantiationState | invalid | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | whether the VNFC instance is instantiated
|
closedLoopStatus | closedLoopStatus | 1 | OpenModelAttribute
OnapModelLifecycle
Experimental | Whether closed loop capabilities are enabled for this or not.
|
_vdu | Vdu | 1 | OpenModelAttribute
OnapModelLifecycle
| Reference to the VDU
|
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. References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD)
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfProvider | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Provider of the VNF and of the VNFD.
|
vnfProductName | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Name to identify the VNF Product. Invariant for the VNF Product lifetime.
|
vnfSoftwareVersion | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package.
|
vnfdVersion | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifies the version of the VNFD.
|
vnfProductInfoName | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable name for the VNF Product. Can change during the VNF Product lifetime.
|
vnfProductInfoDescription | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the VNF Product. Can change during the VNF Product lifetime.
|
vnfmInfo | String | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Identifies VNFM(s) compatible with the VNF described in this version of the VNFD.
|
localizationLanguage | String | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Information about localization languages of the VNF (includes e.g. strings in the VNFD). 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation.
|
vnfdId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Information about localization languages of the VNF (includes e.g. strings in the VNFD). 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 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing).
|
lifecycleManagementScript | VnfLifecycleManagementScript | 0..* | OpenModelAttribute
Preliminary OnapModelLifecycle
| Includes a list of events and corresponding management scripts performed for the VNF.
|
logo | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| File path of the vendor specified logo.
|
guide | String | 0..1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model.
|
_vdu | Vdu | 1..* | OpenModelAttribute
OnapModelLifecycle
| Virtualisation Deployment Unit.
|
_vnfExtCpd | VnfExtCpd | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes external interface(s) exposed by this VNF enabling connection with a VL.
|
_deploymentFlavour | VnfDf | 1..* | OpenModelAttribute
OnapModelLifecycle
| Describes specific DF(s) of a VNF with specific requirements for capacity and performance.
|
_vnfIndicator | VnfIndicator | 0..* | OpenModelAttribute
OnapModelLifecycle
| Declares the VNF indicators that are supported by this VNF.
|
_elementGroup | VnfdElementGroup | 0..* | OpenModelAttribute
OnapModelLifecycle
| Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management.
|
_virtualComputeDesc | VirtualComputeDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
| Defines descriptors of virtual compute resources to be used by the VNF.
|
_virtualStorageDesc | VirtualStorageDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
| Defines descriptors of virtual storage resources to be used by the VNF.
|
_intVirtuallinkdesc | VnfVirtualLinkDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
| Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP.
|
_vnfReservedCpd | VduCpd | 0..* | OpenModelAttribute
OnapModelLifecycle
| 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.
|
VnfdElementGroup
A VNFD Element Group is a mechanism for associating elements of a VNFD (Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, scaling aspects. A given element can belong to multiple groups.
Applied stereotypes:
- Preliminary
- OpenModelClass
- OnapModelLifecycle
- state: INPUT
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfdElementGroupId | Identifier | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Unique identifier of this group in the VNFD.
|
description | String | 1 | OpenModelAttribute
Preliminary OnapModelLifecycle
| Human readable description of the group.
|
_vdu | Vdu | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
_vnfVirtualLinkdesc | VnfVirtualLinkDesc | 0..* | OpenModelAttribute
OnapModelLifecycle
|
|
Data Types
AddressData
The AddressData information element supports providing information about the addressing scheme and parameters applicable to a CP.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
addressType | Identifier | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Describes the type of the address to be assigned to the CP instantiated from the parent CPD. The content type shall be aligned with the address type supported by the layerProtocol attribute of the parent CPD.
|
l2AddressData | L2AddressData | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Provides the information on the MAC addresses to be assigned to the CP(s) instantiated from the parent CPD. Shall be present when the addressType is MAC address.
|
l3AddressData | L3AddressData | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. Shall be present when the addressType is IP address.
|
ConnectivityType
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
layerProtocol | LayerProtocol | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Identifies the protocol this VL gives access to (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire).
|
flowPattern | String | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Identifies the flow pattern of the connectivity (Line, Tree, Mesh).
|
CpProtocolData
A CpProtocolData information element describes and associates the protocol layer that a CP uses together with other protocol and connection point information.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
associatedLayerProtocol | LayerProtocol | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | One of the values of the attribute layerProtocol of the Cpd IE.
|
addressData | AddressData | 0..* | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Provides information on the addresses to be assigned to the CP(s) instantiated from the CPD.
|
L2AddressData
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
macAddressAssignment | Boolean | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Specify if the MAC address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility. If it is set to False, it will be provided by an external entity, e.g. OSS/BSS.
|
L3AddressData
The L3AddressData information element supports providing information about Layer 3 level addressing scheme and parameters applicable to a CP.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
ipAddressAssignment | Boolean | 1 | RW | OpenModelAttribute
OnapModelLifecycle | Specify if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility.
|
floatingIpActivated | Boolean | 1 | RW | OpenModelAttribute
OnapModelLifecycle | Specify if the floating IP scheme is activated on the CP or not.
|
ipAddressType | AddressType | 0..1 | RW | OpenModelAttribute
OnapModelLifecycle | Define address type. NOTE: The address type should be aligned with the address type supported by the layerProtocol attribute of the parent Cpd.
|
numberOfIpAddress | Integer | 0..1 | RW | OpenModelAttribute
OnapModelLifecycle | Minimum number of IP addresses to be assigned based on this L3AddressData information element.
|
LinkBitrateRequirements
The LinkBitrateRequirements information element describes the requirements in terms of bitrate for a VL.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
root | Number | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Throughput requirement of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
|
leaf | Number | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Throughput requirement of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E?LAN branches). NOTE: The present document does not specify the means to declare different bitrate requirements for leaf connections (e.g. E-LAN leaves).
|
LocalAffinityOrAntiAffinityRule
The LocalAffinityOrAntiAffinityRule describes the affinity or anti-affinity rule applicable between the virtualization containers to be created based on a particular VDU, or between internal VLs to be created based on a particular VnfVirtualLinkDesc. Per VNF, the affinity/anti-affinity rules defined using this information element, using the AffinityOrAntiAffinityGroup information element, and using the placement constraints in the GrantLifecycleOperation as defined in ETSI GS NFV IFA 007 [i.3] should be conflict-free. In case of conflicts, the placement constraints in the GrantLifecycleOperation shall take precedence.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
type | RuleType | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Specifies whether the rule is an affinity rule or an anti-affinity rule.
|
scope | RuleScope | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Specifies the scope of the rule.
|
LogicalNodeData
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.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
logicalNodeRequirement | KeyValuePair | 0..* | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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 virtualised 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.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
id | Identifier | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Unique identifier of the monitoring parameter.
|
name | String | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Human readable name of the monitoring parameter.
|
performanceMetric | String | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle |
|
collectionPeriod | CollectionPeriod | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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.
|
QoS
The QoS information element describes QoS data for a given VL used in a DF.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
latency | Number | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Maximum latency in ms.
|
packetDelayVariation | Number | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Maximum jitter in ms.
|
packetLossRatio | Number | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists.
|
RequestedAdditionalCapabilityData
This information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
supportMandatory | Boolean | 1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | Indicates whether the requested additional capability is mandatory for successful operation.
|
requestedAdditionalCapabilityName | String | 1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | Identifies a requested additional capability for the VDU.
|
minRequestedAdditionalCapabilityVersion | String | 0..1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | Identifies the minimum version of the requested additional capability.
|
preferredRequestedAdditionalCapabilityVersion | String | 0..1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | Identifies the preferred version of the requested additional capability.
|
targetPerformanceParameters | KeyValuePair | 1..* | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | Identifies specific attributes, dependent on the requested additional capability type.
|
ScaleInfo
The ScaleInfo information element represents a scale level for a particular scaling aspect.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
aspectId | Identifier | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Reference to the scaling aspect.
|
scaleLevel | Integer | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
cpuArchitecture | String | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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 OnapModelLifecycle | Number of virtual CPUs.
|
virtualCpuClock | Number | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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 | Obsolete OpenModelAttribute
OnapModelLifecycle | 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 OnapModelLifecycle | Array of key-value pair requirements on the Compute (CPU) for the VDU.
|
virtualCpuPinning | VirtualCpuPinningData | 0..1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | 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.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
virtualCpuPinningPolicy | PinningPolicy | 0..1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | 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 | Obsolete OpenModelAttribute
OnapModelLifecycle | 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.
VirtualMemoryData
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
virtualMemSize | Number | 1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Amount of virtual Memory (e.g. in MB).
|
virtualMemOversubscriptionPolicy | String | 0..1 | RW | Obsolete OpenModelAttribute
Preliminary OnapModelLifecycle | 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 OnapModelLifecycle | Array of key-value pair requirements on the memory for the VDU.
|
numaEnabled | Boolean | 0..1 | RW | Obsolete OpenModelAttribute
OnapModelLifecycle | 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
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
isAutoscaleEnabled | Boolean | 0..1 | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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 OnapModelLifecycle | 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 OnapModelLifecycle |
|
VnfInfoModifiableAttributes
This datatype defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
extension | invalid | 0..* | RW | OpenModelAttribute
OnapModelLifecycle Experimental | "Extension" attributes of VnfInfo that are writeable.
|
metadata | invalid | 0..* | RW | OpenModelAttribute
OnapModelLifecycle Experimental | Metadata" attributes of VnfInfo that are writeable
|
VnfLifecycleManagementScript
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
event | LcmEvent | 0..* | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point.
|
icmTransitionEvent | String | 0..* | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | 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 OnapModelLifecycle | 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 OnapModelLifecycle | 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 OnapModelLifecycle | 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.
|
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.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
additionalVnfcConfigurableProperty | String | 0..* | RW | OpenModelAttribute
Preliminary OnapModelLifecycle | It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation.
|
Enumerations
CollectionPeriod
Specifies the periodicity at which the producer will collect performance information.
Contains Enumeration Literals:
HomingStrategy
Contains Enumeration Literals:
- Colocation:
- isolation:
LayerProtocol
Identifies the protocol this VL gives access to
Contains Enumeration Literals:
- ETHERNET:
- MPLS:
- ODU2:
- IPV4:
- IPV6:
- PSEUDOWIRE:
LcmEvent
Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point.
Contains Enumeration Literals:
NetworkType
Type of network supported.
Contains Enumeration Literals:
- VLAN:
- VXLAN:
OperationalStatus
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Contains Enumeration Literals:
- in-service-path:
- ot-of-service-path:
PinningPolicy
Defines the CPU pinning policy.
Contains Enumeration Literals:
- STATIC:
- DYNAMIC:
PlacementStrategy
Contains Enumeration Literals:
- Colocation:
- isolation:
- Exlusivity:
ProvStatus
Provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems.
Contains Enumeration Literals:
- PROVISIONED:
- PREPROVISIONED:
- CAPPED:
RuleScope
Defines the scope of the rule.
Contains Enumeration Literals:
- NFVI_POP:
- ZONE:
- ZONE_GROUP:
- NFVI_NODE:
RuleType
Specifies the type of rule.
Contains Enumeration Literals:
- AFFINITY:
- ANTI_AFFINITY:
VnfSource
Describes the source of the indicator.
Contains Enumeration Literals:
- VNF:
- EM:
- BOTH:
VnicType
Describes the type of VNIC to which a CP attaches.
Contains Enumeration Literals:
- NORMAL:
- MACVTAP:
- DIRECT:
- BAREMETAL:
- DIRECT_PHYSICAL:
- VIRTIO_FORWARDER:
closedLoopStatus
Contains Enumeration Literals:
- Enabled:
- Disabled: