- Class
- Data Types
These diagrams come from papyrus based on R3 vnf model clean, blue ones are new requirements added.
ONAP Vnfd View
ONAP Vnfd - Topology View
Vnf Deployment Flavor
VNF Instance
Class: Vnf
Attribute Name | Type | Mult. | Stereotypes | Description |
vnfInstanceId | Identifier | 1 | Experimental OpenModelAttribute
| identifier of the VNF instance
|
vnfInstanceName | String | 1..* | Experimental OpenModelAttribute
| name of the VNF instance. Multiple names are possible.
|
vnfProductName | String | 0..1 | Experimental OpenModelAttribute
| name to identify the VNF Product, invariant for the VNF Product lifetime
|
description | invalid | 0..1 | Experimental OpenModelAttribute
| description of the VNF instance
|
vnfProvider | invalid | 1 | Experimental OpenModelAttribute
| provider of the VNF model
|
vnfdId | Identifier | 1 | Experimental OpenModelAttribute
| identifier of the VNF model
|
vnfdVersion | String | 1 | Experimental OpenModelAttribute
| version of the VNF model
|
vnfSoftwareVersion | String | 1 | Experimental OpenModelAttribute
| Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package
|
onboardedVnfPkgInfoId | Identifier | 1 | Experimental OpenModelAttribute
| identifier of the specific VNF package on which the VNF instance is based
|
availabilityZone | invalid | 1 | Experimental OpenModelAttribute
| availability zone information of the VNF instance
|
operationalStatus | OperationalStatus | 0..1 | Experimental OpenModelAttribute
| indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
|
orchestrationStatus | OrchestrationStatus | 1 | Experimental OpenModelAttribute
| whether the VNF instance is instantiated
|
oamlpv4Address | invalid | 0..1 | Experimental OpenModelAttribute
| oam ip address, ipv4
|
oamlpv6Address | invalid | 0..1 | Experimental OpenModelAttribute
| oam ip address, ipv6
|
instantiatedVnfInfo | invalid | 0..1 | Experimental OpenModelAttribute
| information specific to an instantiated VNF instance, e.g., vm information
|
inMaint | Boolean | 0..1 | Experimental OpenModelAttribute
| whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc.
|
isClosedLoopDisabled | Boolean | 0..1 | Experimental OpenModelAttribute
| whether closed loop function is enabled
|
encryptedAccessFlag | Boolean | 0..1 | Experimental OpenModelAttribute
| whether this VNF is accessed using SSH
|
vnfConfigurableProperty | invalid | 0..1 | Experimental OpenModelAttribute
| indicator for whether autoHeal and autoScale is enabled
|
nfNamingCode | String | 1 | Experimental OpenModelAttribute
| String assigned to this model used for naming purpose.
|
vnfNamingPolicyId | String | 1 | Experimental OpenModelAttribute
| Identifier of the policy which has the naming logic for this VNF instance
|
vnfHomingPolicyId | String | 1 | Experimental OpenModelAttribute
| Identifier of the policy which provides homing conditions.
|
nfType | String | 1 | Experimental OpenModelAttribute
| Generic description of the type of network function
|
nfFunction | String | 1 | Experimental OpenModelAttribute
| English description of network function that the specific VNF deployment is providing.
|
nfRole | String | 1 | Experimental OpenModelAttribute
| Role in the network this model will be providing
|
closedLoopStatus | ClosedLoopStatus | 1 | Experimental OpenModelAttribute
| Whether closed loop capabilities are enabled for this or not.
|
_nfc (vnfcinstance) | Vnfc | 1..* | Experimental OpenModelAttribute
| Relatonship to the NF components that are part of this VNF.
|
_vnfd | Vnfd | 1 | Experimental OpenModelAttribute
| Relationship to the VNF descriptor
|
_vnfvirtuallink | VnfVirtualLink | 0..* | Experimental OpenModelAttribute
| Relationship to VnfVirtualLink
|
veVnfmVnfInterface | String | 0..1 | OpenModelAttribute
| IP address between VNF and VNFM.
|
Class: Vdu
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. 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. 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.
|
_vduCpd | VduCpd | 1 | Preliminary OpenModelAttribute
| Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL).
|
_virtualComputeDesc | VirtualComputeDesc | 1..* | Preliminary OpenModelAttribute
| Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.
|
_virtualStorageDesc | VirtualStorageDesc | 0..* | Preliminary OpenModelAttribute
| Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.
|
_swImageDesc | SwImageDesc | 0..1 | 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..* | OpenModelAttribute
| Specify instantiation priority and dependencies of VDU.
|
Class: VduCpd
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 | 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. comment: creat cpd profile, define the number of instances.
|
securityGroups | String | 0..* | OpenModelAttribute
| VNFD needs to specify the security group name {security_groups} for each vNic.
|
portSecurityEnabled | Boolean | 0..1 | OpenModelAttribute
| VNFD needs to specify whether to enable security group for the vNic.
|
qos | QoS | 0..1 | OpenModelAttribute
| Describe the Qos requirements of the VduCpd.
|
cpdId | Identifier | 1 | Preliminary OpenModelAttribute
| Identifier of this Cpd information element.
|
cpRole | 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).
|
allowedAddressData | AddressData | 0..* | Preliminary OpenModelAttribute
| For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.
|
Class: VduProfile
Attribute Name | Type | Mult. | Stereotypes | Description |
vdudId | Identifier | 1 | Preliminary OpenModelAttribute
| Uniquely identifies a VDU.
|
minNumberOfInstances | Integer | 1 | Preliminary OpenModelAttribute
| Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.
|
maxNumberOfInstances | Integer | 1 | Preliminary OpenModelAttribute
| Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.
|
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..* | Preliminary OpenModelAttribute
| 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..* | Preliminary OpenModelAttribute
| 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 | Preliminary OpenModelAttribute
| 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 | Preliminary OpenModelAttribute
| Timeout value for the VNFM to wait before the successful booting up of the VDU.
|
securityGroups | String | 0..* | OpenModelAttribute
| VNFD needs to specify the security group name {security_groups} for each VDU.
|
flavorExtraSpecs | KeyValuePair | 0..* | OpenModelAttribute
| Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate label).
|
Class: VirtualLinkProfile
Attribute Name | Type | Mult. | Stereotypes | Description |
localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..* | Preliminary OpenModelAttribute
| 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..* | Preliminary OpenModelAttribute
| 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 | Preliminary OpenModelAttribute
| Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
minBitRateRequirements | LinkBitrateRequirements | 1 | Preliminary OpenModelAttribute
| Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
|
initiationParameters | KeyValuePair | 0..* | Preliminary OpenModelAttribute
| Specifies initiation parameters for the virtual link.
|
_virtualLinkDescFlavour | VirtualLinkDescFlavour | 1 | Preliminary OpenModelAttribute
| Identifies a flavour within the VnfVirtualLinkDesc.
|
_virtualLinkDesc | LinkDesc | 1 | Preliminary OpenModelAttribute
| Uniquely identifies a Vnf VLD.
|
virtualLinkProtocolData (Aligned with IFA 011v2.5.1) | VirtualLinkProtocolData | 0..* | OpenModelAttribute
| Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no protocol data needs to be specified.
|
Class: VirtualStorageDesc
Attribute Name | Type | Mult. | Stereotypes | Description |
id | Identifier | 1 | Preliminary OpenModelAttribute
| Unique identifier of this VirtualStorageDesc in the VNFD.
|
typeOfStorage | String | 1 | Preliminary OpenModelAttribute
| Type of virtualised storage resource (e.g. volume, object).
|
sizeOfStorage | Number | 1 | Preliminary OpenModelAttribute
| Size of virtualised storage resource (e.g. size of volume, in GB).
|
vduStorageRequirements | KeyValuePair | 0..* | Preliminary OpenModelAttribute
| An array of key-value pairs that articulate the storage deployment requirements.
|
rdmaEnabled | Boolean | 0..1 | OpenModelAttribute
Obsolete | Indicate if the storage support RDMA.
|
swImageDesc | Identifier | 0..1 | Preliminary OpenModelAttribute
| Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc.
|
multiAttach | Boolean | 0..1 | OpenModelAttribute
| Indicating whether a vDisk is a shared volume in VNFD.
|
storageQos | StorageQos | 0..1 | OpenModelAttribute
| Describe storage Qos.
|
volumeType | VolumeType | 0..1 | OpenModelAttribute
|
|
Datatype: VirtualLinkProtocolData (Aligned with IFA 011v2.5.1)
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
associatedLayerProtocol | Enum | 1 | RW | OpenModelAttribute
| One of the values of the attribute layerProtocol of the ConnectivityType IE. (Refer to ConnectivityType) |
l2ProtocolData | L2ProtocolData | 0..1 | RW | OpenModelAttribute
| 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
| 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.
|
Datatype: L2ProtocolData
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
networkName (Aligned with IFA 011v2.5.1) | String | 1 | RW | OpenModelAttribute
| Network name associated with this L2 protocol.
|
segmentationId | String | 0..1 | RW | OpenModelAttribute
| Network segment ID. |
networkType (Aligned with IFA 011v2.5.1) | NetworkType | 0..1 | RW | OpenModelAttribute
| Type of the network (VLAN or VxLAN). |
physicalNetwork | String | 0..1 | RW | OpenModelAttribute
| The connected physical network of network type (VLAN or VxLAN) . |
routerExternal | Boolean | 0..1 | RW | OpenModelAttribute
| Specify if a vrouter comes from an external network. |
vlanTransparent (Aligned with IFA 011v2.5.1) | Boolean | 0..1 | RW | OpenModelAttribute
| Indicating whether "VLAN Transparent Mode" is supported. Default is "FALSE" if not specified otherwise. |
Datatype: L3ProtocolData
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
cidr (Aligned with IFA 011v2.5.1) | String | 1 | RW | OpenModelAttribute
| Address of network CIDR.
|
ipAllocationPools (Aligned with IFA 011v2.5.1) | KeyValuePair | 0..N | RW | OpenModelAttribute
| Specifies the allocation pools with start and end IP addresses for this L3 protocol. See note . |
gatewayIp (Aligned with IFA 011v2.5.1) | String | 0..1 | RW | OpenModelAttribute
| Specifies the gateway IP address for this L3 protocol. See note. |
ipVersion (Aligned with IFA 011v2.5.1) | IpVersion | 1 | RW | OpenModelAttribute
| Define address type, value: • IPv4 address. • IPv6 address. |
ipv6RaMode | Ipv6RaMode | 0..1 | RW | OpenModelAttribute
| Specifies IPv6 address mode for vrouter. Possible values: • SLAAC. • DHCPV6-STATEFUL. • DHCPV6-STATELESS. May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. Must be present when the VLAN/VXLAN connects to one or more vrouters. Note2: The value of ipv6RaMode and ipv6AddressMode must be same. |
ipv6AddressMode (Aligned with IFA 011v2.5.1) | Ipv6AddressMode | 0..1 | RW | OpenModelAttribute
| Specifies IPv6 address mode for DHCP. Possible values: • SLAAC. • DHCPV6-STATEFUL. • DHCPV6-STATELESS. May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. See Note. |
hostRoutes | KeyValuePair | 0..N | RW | OpenModelAttribute
| Static routing list, including estination and nexthop information. |
dnsNameServers | String | 0..N | RW | OpenModelAttribute
| DNS server list. |
dhcpEnabled (Aligned with IFA 011v2.5.1)
| Boolean | 0..1 | RW | OpenModelAttribute
| Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. |
Note: If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value is provided at design time in the VNFD. If a default value is provided at design-time, this value may be overridden at run-time. |
Datatype: Qos
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
latency | Number | 1 | RW | OpenModelAttribute
Preliminary | Maximum latency in ms.
|
packetDelayVariation | Number | 1 | RW | OpenModelAttribute
Preliminary | Maximum jitter in ms.
|
packetLossRatio | Number | 0..1 | RW | OpenModelAttribute
Preliminary | Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists.
|
qosId | Identifier | 1 | RW | OpenModelAttribute
| Qos ID.
|
qosName | String | 1 | RW | OpenModelAttribute
| Human readable Qos name.
|
rules | KeyValuePair | 0..* | RW | OpenModelAttribute
| Detailed requirements of Qos, including maximum bandwidth limitation{max_kbps}、maximum burst bandwidth limitation{max_burst_kbps} 、direction{egress|ingress},etc.
|
Datatype: StorageQos
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
qosId | Identifier | 1 | RW | OpenModelAttribute
| Unique identifier of the storage Qos in VNFD.
|
qosName | String | 1 | RW | OpenModelAttribute
| Name of storage QoS.
|
consumer | consumerScope | 1 | RW | OpenModelAttribute
| Consumer type.
|
qos_specs | KeyValuePair | 0..* | RW | OpenModelAttribute
| Describe qualities of Qos:total_bytes_sec、total_iops_sec.
|
Datatype: VolumeType
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
volumeTypeId | Identifier | 1 | RW | OpenModelAttribute
| Unique identifier of volume type in VNFD.
|
volumeTypeName | String | 1 | RW | OpenModelAttribute
| Name of volume type.
|
backendName | String | 1 | RW | OpenModelAttribute
| Backend volume name of cinder.
|
Datatype: LocalAffinityOrAntiAffinityRule
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
type | RuleType | 1 | RW | OpenModelAttribute
Preliminary | Specifies whether the rule is an affinity rule or an anti-affinity rule.
|
scope | RuleScope | 1 | RW | OpenModelAttribute
Preliminary | Specifies the scope of the rule. Currently, the scopes of the rule include:
Suggest to add NFVI_NIC.
|
Enumerations:
1. consumerScope
Contains Enumeration Literals:
- back-end
2. NetworkType
Contains Enumeration Literals:
- VLAN
- VXLAN
Contains Enumeration Literals:
- IPv4 address
- IPv6 address