Page History

Table of Contents

printable	false

...

These diagrams come from papyrus based on R3 vnf model clean, blue ones are new requirements added.

ONAP Vnfd View

Image Removed

ONAP Vnfd - Topology View

Image Removed

Vnf Deployment Flavor

Image Removed

VNF Instance

Image Removed

Class: Vnf

COLOR EXPLANATION: Black means already have in R3, all the attributes with colors are new requirements to propose. Blue means haved discussed, pink means haven't yet. Currently, all the attributes have been introduced, so pink is no longer have, all the pink attributes turn into blue ones. Red means already have in ONAP, but to align with new IFA 011 v2.5.1, I suggest to remove them from the current position to the new places I list here. Orange means the suggested modifications for the discussed attributes.

If the proposed attributes are aligned with IFA specs, you will find a sentence below the attribute name, if not, they are the extended requirements.

ONAP Vnfd View

Image Added

ONAP Vnfd - Topology View

Image Added

Vnf Deployment Flavor

Image Added

VNF Instance

Image Added

Class: Vnf

Attribute Name	Type	Mult.	Stereotypes	Description	Rationale
vnfInstanceId	Identifier

Attribute Name

Type

Mult.

Stereotypes

Description

vnfInstanceId

Identifier

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

identifier of the VNF instance

vnfInstanceName

String

1..*

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

name of the VNF instance. Multiple names are possible.

vnfProductName

String

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

name to identify the VNF Product, invariant for the VNF Product lifetime

description

invalid

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

description of the VNF instance

vnfProvider

invalid

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

provider of the VNF model

vnfdId

Identifier

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

identifier of the VNF model

vnfdVersion

String

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

version of the VNF model

vnfSoftwareVersion

String

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Software version

identifier of the VNF

. This is changed when there is any change to the software that is included in the VNF package

instance

onboardedVnfPkgInfoId

vnfInstanceName

Identifier

String

1..*

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

identifier

name of the

specific VNF package on which the VNF instance is based

VNF instance. Multiple names are possible.

availabilityZone

vnfProductName

invalid

String

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

availability zone information of the VNF instance

name to identify the VNF Product, invariant for the VNF Product lifetime

operationalStatus

description

OperationalStatus

invalid

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

description of the VNF instance

orchestrationStatus

vnfProvider

OrchestrationStatus

invalid

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

whether

provider of the VNF

instance is instantiated

model

oamlpv4Address

vnfdId

invalid

Identifier

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

oam ip address, ipv4

identifier of the VNF model

oamlpv6Address

vnfdVersion

invalid

String

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

version of the VNF model

oam ip address, ipv6

instantiatedVnfInfo

vnfSoftwareVersion

invalid

String

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range

constraint

support: MANDATORY

information specific to an instantiated VNF instance, e.g., vm information

constraint
support: MANDATORY

Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package

inMaint

onboardedVnfPkgInfoId

Boolean

Identifier

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

whether

identifier of the specific VNF package on which the VNF instance is

in maintenance mode, if yes, DCAE will not observe alarms/traps, etc.

based

isClosedLoopDisabled

availabilityZone

Boolean

invalid

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

whether closed loop function is enabled

availability zone information of the VNF instance

encryptedAccessFlag

operationalStatus

Boolean

OperationalStatus

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

indicator for whether

this VNF is accessed using SSH

the resource is considered operational. Valid values are in-service-path and out-of-service-path.

vnfConfigurableProperty

orchestrationStatus

invalid

OrchestrationStatus

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

indicator for whether autoHeal and autoScale is enabled

whether the VNF instance is instantiated

oamlpv4Address

nfNamingCode

~~invalid~~

String

IpAddress

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

String assigned to this model used for naming purpose.

oam ip address, ipv4

oamlpv6Address

vnfNamingPolicyId

~~invalid~~

String

IpAddress

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Identifier of the policy which has the naming logic for this VNF instance

oam ip address, ipv6

vnfHomingPolicyId

instantiatedVnfInfo

String

invalid

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Identifier of the policy which provides homing conditions.

information specific to an instantiated VNF instance, e.g., vm information

nfType

inMaint

String

Boolean

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint

support: MANDATORY

Generic description of the type of network function

nfFunction

String

support: MANDATORY

whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc.

isClosedLoopDisabled

Boolean

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

English description of network function that the specific VNF deployment is providing.

whether closed loop function is enabled

nfRole

encryptedAccessFlag

String

Boolean

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Role in the network this model will be providing

whether this VNF is accessed using SSH

closedLoopStatus

vnfConfigurableProperty

ClosedLoopStatus

invalid

0..1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Whether closed loop capabilities are enabled for this or not.

indicator for whether autoHeal and autoScale is enabled

_nfc (vnfcinstance)

Vnfc


nfNamingCode	String	1

1..*

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Relatonship to the NF components that are part of this VNF.

String assigned to this model used for naming purpose.

_vnfd

vnfNamingPolicyId

Vnfd

String

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Relationship to the VNF descriptor

Identifier of the policy which has the naming logic for this VNF instance

_vnfvirtuallink

vnfHomingPolicyId

VnfVirtualLink

0..*

String

1

Experimental

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Relationship to VnfVirtualLink

Identifier of the policy which provides homing conditions.

veVnfmVnfInterface

nfType

String

0..

1	Experimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

IP address between VNF and VNFM.

Generic description of the type of network function

...

Name

Attribute			Type	Mult.	Stereotypes	Description
nfFunction	String	vduId	Identifier	1	PreliminaryExperimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Unique identifier of this Vdu in VNFDEnglish description of network function that the specific VNF deployment is providing.
nfRolename	String	1	PreliminaryExperimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Role in the network this model will be providing Human readable name of the Vdu.
descriptionclosedLoopStatus	StringClosedLoopStatus	1	PreliminaryExperimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Whether closed loop capabilities are enabled for this or not. Human readable description of the Vdu.
_nfc (vnfcinstance)	Vnfc	1	bootOrder	KeyValuePair	0..*	PreliminaryExperimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Relatonship to the NF components that are part of this VNF. 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_vnfd	KeyValuePair	0..*	Vnfd	1	ExperimentalPreliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Relationship to the VNF descriptor 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_vnfvirtuallink	MonitoringParameterVnfVirtualLink	0..*	PreliminaryExperimental OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Relationship to VnfVirtualLink Defines the virtualised resources monitoring parameters on VDU level.

Class: Vdu

Attribute Name

Type

Mult.

Stereotypes

Description

bitrateRequirement

Number

0..

injectFilesAttribute Name	StringType	Mult.	Stereotypes	Description	Rationale
vduId	Identifier	10..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Unique identifier of this Vdu in VNFD. Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process.
configurablePropertiesname	VnfcConfigurablePropertiesString	1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Human readable name of the Vdu. Describes the configurable properties of all VNFC instances based on this VDU.
_vduCpddescription	VduCpdString	1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL)Human readable description of the Vdu.	_virtualComputeDesc	VirtualComputeDesc
bootOrder	KeyValuePair	01..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	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 usedDescribes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.	_virtualStorageDesc
nfviConstraint	KeyValuePairVirtualStorageDesc	0..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	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. storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.
_swImageDescmonitoringParameter	SwImageDescMonitoringParameter	0..1*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	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 resourcesDefines the virtualised resources monitoring parameters on VDU level.
injectFiles	String	_dependOn	Vdu	0..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Specify instantiation priority and dependencies of VDU.

Class: VduCpd

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 isInvariant: false valueRange: no range constraint support: MANDATORY

Bitrate requirement

Describes the configurable properties of all VNFC instances based on this

CP

VDU.

vnicName

_vduCpd

String

VduCpd

0..

1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Describes

the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process.

network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL).

vnicOrder

_virtualComputeDesc

String

VirtualComputeDesc

0

1..

1

*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Describes

the order to create the vNIC within the scope of

CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.

vnicType

VnicType


_virtualStorageDesc	VirtualStorageDesc	0..

1

*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Describes

the type of the vNIC this CP attaches to.

storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.

_

virtualNetworkInterfaceRequirements

swImageDesc

VirtualNetworkInterfaceRequirements

SwImageDesc

0..

*

1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.

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.

sriovAntiAffinityGroup

_dependsOn

Identifier

Vdu

0..

1

*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specify instantiation priority and dependencies of VDU.

OPTIONAL

Each template will write the other VDUs that needed deployed before instantiating this VDU. When VDU A points to VDU B and C, it means need B and C instantiated first. If B needs D and E, then will deploy D and E in advance, utill finding no dependcy, namely the atomic ones. 0 means no dependency.

Class: VduCpd

VNFD needs to specify the security group name {security_groups} for each vNic.

Attribute Name

Type

Mult.

Stereotypes

Description

Rationale

bitrateRequirement

Number

0..1

Preliminary

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

isInvariant: false
valueRange: no range constraint
support: MANDATORY

portSecurityEnabled

Boolean

0..1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

VNFD needs to specify whether to enable security group for the vNicBitrate requirement on this CP.

vnicNameqos

QoSString

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Describe Describes the Qos requirements of the VduCpd.name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process.

cpdIdvnicOrder

IdentifierString

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Describes the order to create the vNIC within the scope of this Vdu.

Identifier of this Cpd information element.

cpRolevnicType

StringVnicType

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Identifies Describes the role type of the vNIC this CP attaches to.

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_virtualNetworkInterfaceRequirements

StringVirtualNetworkInterfaceRequirements

0..1*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.

Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic).

cpProtocolsecurityGroups

CpProtocolDataString

10..*Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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 tableVNFD needs to specify the security group name {security_groups} for each vNic.

See description.

trunkModeportSecurityEnabled

Boolean

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).VNFD needs to specify whether to enable security group for the vNic.

allowedAddressData

See description.

_qos

QoSAddressData

0..*1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY
support: MANDATORY

Describe the Qos requirements of the VduCpdFor specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.

Class: VduProfile

See description.

Qos should be put in the Class level, and thus there should be an association.

Note: In this proposal, I first supplement requirments for "Qos", you can find 3 new attributes in "Qos" class; then need the Qos requirements for VduCpd, namely this association.

cpdId

Attribute Name

Type

Mult.

Stereotypes

Description

vdudId

Identifier

1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Uniquely identifies a VDU.

Identifier of this Cpd information element.

minNumberOfInstances

cpRole

Integer

String

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

maxNumberOfInstances

Integer

1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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.

Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

localAffinityOrAntiAffinityRule

description

LocalAffinityOrAntiAffinityRule

String

0..

*

1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

Specifies affinity or anti-affinity rules applicable between the virtualisation containers

Provides human-readable information on the purpose of the CP (e.g.

virtual machines) to be created based on this VDU.

CP for control plane traffic).

affinityOrAntiAffinityGroupId

cpProtocol

Identifier

CpProtocolData

0

1..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

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

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.

watchdog

trunkMode

String

Boolean

0..

1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc.

Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).

vmBootUpTimeOut

allowedAddressData

Integer

AddressData

0..

1

*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

Timeout value for the VNFM to wait before the successful booting up of the VDU.

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

Rationale

vdudId

Identifier

1

Preliminary

securityGroups

String

0..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

VNFD needs to specify the security group name {security_groups} for each Uniquely identifies a VDU.

minNumberOfInstances

Integer

1

Preliminary

flavorExtraSpecs

KeyValuePair

0..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate label).

Class: VirtualLinkProfile

Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

maxNumberOfInstances

Integer

1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

Attribute Name

Type

Mult.

Stereotypes

Description

localAffinityOrAntiAffinityRule

LocalAffinityOrAntiAffinityRule

0..*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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.

virtualisation containers (e.g. virtual machines) to be created based on this VDU.

affinityOrAntiAffinityGroupId

Identifier

0..*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Identifier(s) of the affinity or anti-affinity group(s) the

VnfVirtualLinkDesc

VDU belongs to. NOTE: Each identifier references an

affinity or anti-affinity group which expresses affinity or anti-affinity

relationship

relationships between the

VL

virtualisation container(s)

using this VnfVirtualLinkDesc and the VL

(e.g. virtual machine(s))

using other VnfVirtualLinkDesc(s) in the same group.

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.

maxBitRateRequirements

LinkBitrateRequirements

1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies the minimum bitrate requirements for a VL instantiated according to this profile.

minBitRateRequirements

watchdog

LinkBitrateRequirements

String

0..1

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies the minimum bitrate requirements for a VL instantiated according to this profile.

Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc.

initiationParameters

vmBootUpTimeOut

KeyValuePair

Integer

0..

*

1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

Specifies initiation parameters

Timeout value for the

virtual link

VNFM to wait before the successful booting up of the VDU.

_virtualLinkDescFlavour

VirtualLinkDescFlavour

securityGroups

1

String

0..*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Identifies a flavour within the VnfVirtualLinkDesc

VNFD needs to specify the security group name {security_groups} for each VDU.

_virtualLinkDesc

LinkDesc

1

See description.
flavorExtraSpecs	KeyValuePair	0..*

Preliminary

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support:

MANDATORYUniquely identifies a Vnf VLD

MANDATORY

Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate label).

virtualLinkProtocolData

(Aligned with IFA 011v2.5.1)

VirtualLinkProtocolData

0..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

This attribute is the extension for Openstack flavor, currently including:

HA property (Host Aggregate label).
CPU allocation strategy: whether two vCPUs need binding core together or not.
Multi-queue vNic: whether to use multi-queue network card mode or not.
Real-time performance of network elements: whether to open this function or not.

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	Rationale
id	Identifier	1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Unique identifier of this VirtualStorageDesc in the VNFD.
typeOfStorage	String	1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Type of virtualised storage resource (e.g. volume, object).
sizeOfStorage	Number	1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Size of virtualised storage resource (e.g. size of volume, in GB).
vduStorageRequirements	KeyValuePair	0..*	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	An array of key-value pairs that articulate the storage deployment requirements.
rdmaEnabled	Boolean	0..1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Obsolete	Indicate if the storage support RDMA.
swImageDesc	Identifier	0..1	Preliminary OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc.
multiAttach	Boolean	0..1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Indicating whether a vDisk is a shared volume in VNFD. is a shared volume in VNFD.	Each vDisk corresponds to one volume, it should set if the volume can be shared by other VMs.
_storageQos	StorageQos	0..1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Describe storage Qos requirements.	Describe special Qos requirements for storage, see datatype"StorageQos" for details.
~~volumeType~~ _volumeType	VolumeType	0..1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Describe the volume type a storage is based on.	In Openstack, a backend can have multiple volume types to choose, when instantiate a vStorage, must specify one volume type.

Datatype:

...

L2ProtocolData

Attribute Name

Type

Mult.

Access

Stereotypes

Description

associatedLayerProtocol

AssociatedLayerProtocol

Description

Rationale

name

(Aligned with IFA 011v2.5.1)

String

0..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

One of the values of the attribute layerProtocol of the ConnectivityType IE.

(Refer to ConnectivityType)

l2ProtocolData

L2ProtocolData

Network name associated with this L2 protocol.

networkType

(Aligned with IFA 011v2.5.1)

NetworkType

0

..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies the

L2 protocol data OpenModelAttribute

network type 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

L2 protocol. Possible values: FLAT, VLAN, VXLAN, GRE.

vlanTransparent

(Aligned with IFA 011v2.5.1)

Boolean

0..1

RW

OpenModelAttribute

Attribute Name

Type

Mult.

Access

Stereotypes

Description

networkName

(Aligned with IFA 011v2.5.1)

String

0..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

Indicating whether "VLAN Transparent Mode" is supported. Default is "FALSE" if not specified otherwise.
segmentationId	String	0..1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Network segment ID.	The id of vlan/vxlan.
physicalNetwork	String	0..1	RW	OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Network name associated with this L2 protocol.

The connected physical network of network type (VLAN or VxLAN) .	When vlan or vxlan is going to connecting a physical network, it should specify the name of host port.
routerExternal	Boolean	0

segmentationId String 0

..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Network segment ID.

networkType

(Aligned with IFA 011v2.5.1)

NetworkType 0..1 RW OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Type of the network (VLAN or VxLAN). physicalNetwork String 0..1 RW OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The connected physical network of network type (VLAN or VxLAN) .routerExternal Boolean 0..1 RW

Specify if a vrouter comes from an external network.

There are two usage situations of vrouters, one is using in the virtual network internally, another is using to connet to the external network. This attribute shows the two situations, if "true", then the vrouter is using to connect another network; if "false", then using internally.

Datatype: L3ProtocolData

Attribute Name

Type

Mult.

Access

Stereotypes

Description

Rationale

cidr

(Aligned with IFA 011v2.5.1)

String

1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specify if a vrouter comes from an external network.

Specifies the CIDR (Classless Inter- Domain Routing) of this L3 protocol.

See note.

ipAllocationPools

vlanTransparent

(Aligned with IFA 011v2.5.1)

Boolean

KeyValuePair

0

0..

1

N

RW

OpenModelAttribute

isInvariant: false
valueRange:

no range constraint

support: MANDATORY

Indicating whether "VLAN Transparent Mode" is supported. Default is "FALSE" if not specified otherwise.

...

Attribute Name

Type

Mult.

Access

Stereotypes

Description

cidr

no range constraint
support:

...

MANDATORY	Specifies the allocation pools with start and end IP addresses for this L3 protocol. See note .
gatewayIp

(Aligned with IFA 011v2.5.1)

String

IpAddress

0..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies the CIDR (Classless Inter- Domain Routing) of

Specifies the gateway IP address for this L3 protocol.

See note.

ipAllocationPools OpenModelAttribute

ipVersion

(Aligned with IFA 011v2.5.1)

KeyValuePair0..N RW

IpVersion

1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies

the allocation pools with start and end IP addresses for

IP version of this L3 protocol.

See note . gatewayIp

Value:
• IPV4.
• IPV6.

dhcpEnabled

(Aligned with IFA 011v2.5.1)

String

Boolean

0..

1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Indicates whether DHCP (Dynamic Host
Configuration Protocol) is enabled or
disabled

Specifies the gateway IP address

for this L3 protocol. See note.

ipVersion

ipv6AddressMode

(Aligned with IFA 011v2.5.1)

IpVersion

Ipv6AddressMode

0..1

1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support:

MANDATORY

Define address type, value:

• IPv4 address.

MANDATORY

Specifies IPv6 address mode. 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

• IPv6 address

.

ipv6RaMode

Ipv6AddressMode

0..1

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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)

Ipv6AddressMode0..1 RW OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Specifies IPv6 address mode for DHCP. Possible values:

• SLAAC.

• DHCPV6-STATEFUL.

• DHCPV6-STATELESS.

ipv6AddressMode must be same.

This attribute comes from Openstack demand, the address mode should be separately set for vRouter and dhcp. The usage for the ipv6RaMode and ipv6AddressMode has the following situation:

Both attributes don't specify address modes.
Ipv6RaMode doesn't specify an address mode, while ipv6AddressMode has one of the modes for dhcp
Both attributes have to set address mode, then they must be the same value.

May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. See Note.


hostRoutes	KeyValuePair

0

0..N

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Static routing list, including estination and nexthop information.

dnsNameServers String 0..N RW OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

DNS server list.

dhcpEnabled

(Aligned with IFA 011v2.5.1)

Boolean

See description. Estination and nexthop will be provided by network elements.
dnsNameServers	String	0..

1

N

RW

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise

DNS server list.	See description.
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.

...

Class: Qos (Suggest to change to class instead of data type)

Attribute Name	Type	Mult.	Access	Stereotypes	Description	Rationale
latency	Number	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Maximum latency in ms.
packetDelayVariation	Number	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Maximum jitter in ms.
packetLossRatio	Number	0..1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists.
qosId	Identifier	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Qos ID.	Give Qos an id for muliple classes to quote. This means Qos will be a class.
qosName	String	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Human readable Qos name.	Human readable name, corresponding to qosId.
rules	KeyValuePair	0..*	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Detailed requirements of Qos, including maximum bandwidth limitation{max_kbps}、maximum burst bandwidth limitation{max_burst_kbps} 、direction{egress\|ingress}，etc..

...

See description.

Note: the whole Qos attributes are needed for both VL and VduCpd.

Class: StorageQos

Attribute Name	Type	Mult.	Access	Stereotypes	Description	Rationale
qosId	Identifier	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Unique identifier of the storage Qos in VNFD.	See description.
qosName	String	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Name of storage QoS.	Human readable name, corresponding to the Id.
consumer	consumerScopeConsumerScope	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Consumer type. BACK_END LOCAL	Identify the volume which a Storge is based on comes from the backend or local.
qosSpecsqos_specs	KeyValuePair	0..*	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Describe qualities of Qos：total read/write rate{total_bytes_sec}、total read/write IOPS{total_iops_sec}.

...

This is used for the information of basic stroge Qos requirements.

Class: VolumeType

Attribute Name	Type	Mult.	Access	Stereotypes	Description	Rationale
volumeTypeId	Identifier	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Unique identifier of volume type in VNFD.	See description.
volumeTypeName	String	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Name of volume type.	Human readable name, corresponding to the Id.
backendName	String	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	Name of the object linking to the backend distributed storage.(Name in cinder)

Enumerations:

1. consumerScope

Contains Enumeration Literals:

back-end
2. NetworkType
Contains Enumeration Literals:
- VLAN
- VXLAN
3. IpVersion
Contains Enumeration Literals:
- IPv4 address
- IPv6 address

4. AssociatedLayerProtocol

Contains Enumeration Literals:

Ethernet, MPLS, ODU2, IPV4, IPV6 and Pseudo-Wire.

Suggested changes for sriovAntiAffinityGroup:

support: MANDATORY

Name of the object linking to the backend distributed storage.(Name in cinder)

Each volume type has a corresponding backend, the name is also the name in Openstack Cinder configuration.

Class: VnfDf

Attribute Name	Type	Mult.	Stereotypes	Description
flavorId	Identifier	1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Identifier of this DF within the VNFD.
description	String	1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Human readable description of the DF.
_virtuaLlinkProfile	VirtualLinkProfile	0..*	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	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 isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	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 isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	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 isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling.
_vduProfile	VduProfile	1..*	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Describes additional instantiation data for the VDUs used in this flavor.
_vduCpdProfile	VduCpdProfile	1..*	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Describes additional instantiation data for the vduCpds used in this flavour.
_placementGroup	PlacementGroup	0..*	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Determine where VNFC's (VDU's) are placed with respect to the VNF
_baseConfigGroup	BaseConfigGroup	1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	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 isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF.
_scalinggroup	ScalingGroup	0..*	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together.

Class: VduCpdProfile

Attribute Name

Type

Mult.

Stereotypes

Description

vduCpdId

Identifier

(Reference to VduCpd)

_vduCpd

VduCpd

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Preliminary

Uniquely identifies a VduCpd.

AffinityOrAntiAffinityGroupId

_AffinityOrAntiAffinityGroup

Identifier

AffinityOrAntiAffinityGroup

0..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Preliminary

Identifier(s) of the affinity or anti-affinity group(s) the

VDU

VduCpd belongs to.

DatatypeClass: AffinityOrAntiAffinityGroup

Attribute Name	Type	Mult.	Access	Stereotypes	Description
groupId	Identifier	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Identifies an affinity or anti-affinity group to which the affinity or anti-affinity rule applies.
type	RuleType	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Specifies whether the rule is an affinity rule or an anti-affinity rule.
scope	RuleScope	1	RW	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Preliminary	Specifies the scope of the rule. Currently, the scopes of the rule include: NFVI_POP ZONE ZONE_GROUP NFVI_NODE. Suggest to add NFVI_NIC.

Enumerations

1. ConsumerScope

Contains Enumeration Literals:

BACK_END
LOCAL
2. NetworkType
Contains Enumeration Literals:
- VLAN
- VXLAN
- FLAT
- GRE
3. IpVersion
Contains Enumeration Literals:
- IPv4
- IPv6

4. AssociatedLayerProtocol

Contains Enumeration Literals:

Ethernet, MPLS, ODU2, IPV4, IPV6 and Pseudo-Wire.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 38

New Version Current

Key

ONAP Vnfd View

Image Removed

ONAP Vnfd - Topology View

Image Removed

Vnf Deployment Flavor

Image Removed

VNF Instance

Image Removed

Class: Vnf

ONAP Vnfd View

Image Added

ONAP Vnfd - Topology View

Image Added

Vnf Deployment Flavor

Image Added

VNF Instance

Class: Vnf

Class: Vdu

Class: VduCpd

Class: VduCpd

Class: VduProfile

Class: VduProfile

Class: VirtualLinkProfile

Class: VirtualStorageDesc

Datatype:

L2ProtocolData

Datatype: L2ProtocolData

Datatype: L3ProtocolData

Class: Qos (Suggest to change to class instead of data type)

Class: StorageQos

Class: VolumeType

Enumerations:

1. consumerScope

2. NetworkType

Class: VnfDf

Enumerations