vnfd - Programmers API Reference

Schema Globals

Global Schema Type
rw_ypbc_Vnfd_Vnfd_t_schema
Global Schema Pointer
rw_ypbc_Vnfd_Vnfd_g_schema

vnfd data

vnfd:vnfd-catalog

Virtual Network Function Descriptor (VNFD).

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog
XPath Keyed Path
/vnfd:vnfd-catalog
RW.REST URI Path
/vnfd:vnfd-catalog
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog
Vnfd_data_VnfdCatalog
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog

Fields
NameTypeDescription
vnfdLIST

vnfd:vnfd

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd
Vnfd_data_VnfdCatalog_Vnfd
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd

Fields
NameTypeDescription
idSTRINGIdentifier for the VNFD.
nameSTRINGVNFD name.
short-nameSTRINGShort name to appear as label in the UI
vendorSTRINGVendor of the VNFD.
logoSTRINGVendor logo for the Virtual Network Function
descriptionSTRINGDescription of the VNFD.
versionSTRINGVersion of the VNFD
vnf-configurationCONTAINERInformation about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
mgmt-interfaceCONTAINERInterface over which the VNF is managed.
internal-vldLISTList of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system.
ip-profilesLISTList of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
connection-pointLISTList for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.
vduLISTList of Virtual Deployment Units
vdu-dependencyLISTList of VDU dependencies.
service-function-chainENUMType of node in Service Function Chaining Architecture
service-function-typeSTRINGType of Service Function. NOTE: This needs to map with Service Function Type in ODL to support VNFFG. Service Function Type is mandatory param in ODL SFC. This is temporarily set to string for ease of use
http-endpointLISTList of http endpoints to be used by monitoring params
monitoring-paramLISTList of monitoring parameters at the network service level
placement-groupsLISTList of placement groups at VNF level

vnfd:vnf-configuration

Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration
Python Proto-GI Type
VnfdYang.VnfConfiguration
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration
Vnfd_VnfConfiguration
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration

Fields
NameTypeDescription
netconfCONTAINER
restCONTAINER
scriptCONTAINER
jujuCONTAINER
config-accessCONTAINER
config-attributesCONTAINERMiscellaneous input parameters to be considered while processing the NSD to apply configuration
service-primitiveLISTList of service primitives supported by the configuration agent for this VNF.
initial-config-primitiveLISTInitial set of configuration primitives.
config-templateSTRINGConfiguration template for each VNF

vnfd:netconf

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:netconf
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:netconf
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/netconf
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:netconf
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:netconf
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Netconf
Python Proto-GI Type
VnfdYang.VnfConfiguration_Netconf
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Netconf
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Netconf
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Netconf
Vnfd_VnfConfiguration_Netconf
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Netconf

Fields
NameTypeDescription
targetENUMNetconf configuration target
protocolENUMProtocol to use for NETCONF, such as ssh
portUINT16Port for the NETCONF server.

vnfd:rest

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:rest
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:rest
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/rest
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:rest
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:rest
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Rest
Python Proto-GI Type
VnfdYang.VnfConfiguration_Rest
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Rest
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Rest
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Rest
Vnfd_VnfConfiguration_Rest
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Rest

Fields
NameTypeDescription
portUINT16Port for the REST server.

vnfd:script

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:script
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:script
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/script
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:script
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:script
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Script
Python Proto-GI Type
VnfdYang.VnfConfiguration_Script
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Script
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Script
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Script
Vnfd_VnfConfiguration_Script
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Script

Fields
NameTypeDescription
script-typeENUMScript type - currently supported : bash, expect

vnfd:juju

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Juju
Python Proto-GI Type
VnfdYang.VnfConfiguration_Juju
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Juju
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju
Vnfd_VnfConfiguration_Juju
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju

Fields
NameTypeDescription
charmSTRINGJuju charm to use with the VNF.

vnfd:config-access

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-access
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-access
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-access
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-access
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-access
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ConfigAccess
Python Proto-GI Type
VnfdYang.VnfConfiguration_ConfigAccess
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ConfigAccess
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAccess
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAccess
Vnfd_VnfConfiguration_ConfigAccess
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAccess

Fields
NameTypeDescription
mgmt-ip-addressUNIONIP address to be used to configure this VNF, optional if it is possible to resolve dynamically.
usernameSTRINGUser name for configuration.
passwordSTRINGPassword for configuration access authentication.

vnfd:config-attributes

Miscellaneous input parameters to be considered while processing the NSD to apply configuration

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-attributes
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-attributes
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-attributes
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-attributes
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-attributes
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ConfigAttributes
Python Proto-GI Type
VnfdYang.VnfConfiguration_ConfigAttributes
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ConfigAttributes
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAttributes
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAttributes
Vnfd_VnfConfiguration_ConfigAttributes
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigAttributes

Fields
NameTypeDescription
config-priorityUINT64Configuration priority - order of configuration to be applied to each VNF in this NS. A low number takes precedence over a high number
config-delayUINT64Wait (seconds) before applying the configuration to VNF

vnfd:service-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:service-primitive
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:service-primitive[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/service-primitive/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:service-primitive
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:service-primitive[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ServicePrimitive
Python Proto-GI Type
VnfdYang.ServicePrimitive
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ServicePrimitive
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive
Vnfd_ServicePrimitive
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive

Fields
NameTypeDescription
nameSTRINGName of the service primitive.
parameterLISTList of parameters to the service primitive.

vnfd:parameter

List of parameters to the service primitive.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:service-primitive/vnfd:parameter
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:service-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/service-primitive/STRING/parameter/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:service-primitive/vnfd:parameter
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:service-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ServicePrimitive.Parameter
Python Proto-GI Type
VnfdYang.ServicePrimitive_Parameter
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ServicePrimitive__Parameter
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive_Parameter
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive_Parameter
Vnfd_ServicePrimitive_Parameter
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ServicePrimitive_Parameter

Fields
NameTypeDescription
nameSTRINGName of the parameter.
data-typeENUMData type associated with the name.
mandatoryBOOLEANIs this field mandatory
default-valueSTRINGThe default value for this field
parameter-poolSTRINGNSD parameter pool name to use for this parameter
read-onlyBOOLEANThe value should be dimmed by the UI. Only applies to parameters with default values.
hiddenBOOLEANThe value should be hidden by the UI. Only applies to parameters with default values.

vnfd:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:initial-config-primitive
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:initial-config-primitive[vnfd:seq='0']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:initial-config-primitive
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:initial-config-primitive[vnfd:seq='0']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.InitialConfigPrimitive
Python Proto-GI Type
VnfdYang.InitialConfigPrimitive
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__InitialConfigPrimitive
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive
Vnfd_InitialConfigPrimitive
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive

Fields
NameTypeDescription
seqUINT64Sequence number for the configuration primitive.
nameSTRINGName of the configuration primitive.
user-defined-scriptSTRINGA user defined script.
parameterLIST

vnfd:parameter

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:initial-config-primitive/vnfd:parameter
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:initial-config-primitive[vnfd:seq='0']/vnfd:parameter[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0/parameter/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:initial-config-primitive/vnfd:parameter
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:initial-config-primitive[vnfd:seq='0']/vnfd:parameter[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.InitialConfigPrimitive.Parameter
Python Proto-GI Type
VnfdYang.InitialConfigPrimitive_Parameter
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__InitialConfigPrimitive__Parameter
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter
Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter
Vnfd_InitialConfigPrimitive_Parameter
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter

Fields
NameTypeDescription
nameSTRING
valueSTRINGValue of the configuration primitive.

vnfd:mgmt-interface

Interface over which the VNF is managed.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:mgmt-interface
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:mgmt-interface
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:mgmt-interface
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:mgmt-interface
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MgmtInterface
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MgmtInterface
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MgmtInterface
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface
Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface

Fields
NameTypeDescription
ip-addressUNION
vdu-idLEAFREF
cpLEAFREF
portUINT16Port for the management interface.
dashboard-paramsCONTAINERParameters for the VNF dashboard

vnfd:dashboard-params

Parameters for the VNF dashboard

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:mgmt-interface/vnfd:dashboard-params
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:mgmt-interface/vnfd:dashboard-params
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface/dashboard-params
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:mgmt-interface/vnfd:dashboard-params
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:mgmt-interface/vnfd:dashboard-params
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MgmtInterface.DashboardParams
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MgmtInterface__DashboardParams
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams
Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams

Fields
NameTypeDescription
pathSTRINGThe HTTP path for the dashboard
httpsBOOLEANPick HTTPS instead of HTTP , Default is false
portUINT16The HTTP port for the dashboard

vnfd:internal-vld

List of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.InternalVld
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_InternalVld
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__InternalVld
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld
Vnfd_data_VnfdCatalog_Vnfd_InternalVld
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld

Fields
NameTypeDescription
idSTRINGIdentifier for the VLD
nameSTRINGName of the internal VLD
short-nameSTRINGShort name to appear as label in the UI
descriptionSTRINGDescription of internal VLD.
typeENUM
root-bandwidthUINT64For ELAN this is the aggregate bandwidth.
leaf-bandwidthUINT64For ELAN this is the bandwidth of branches.
internal-connection-pointLISTList of internal connection points in this VLD
provider-networkCONTAINERContainer for the provider network.
vim-network-nameSTRINGName of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
ip-profile-refLEAFREFNamed reference to IP-profile object

vnfd:internal-connection-point

List of internal connection points in this VLD

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld/vnfd:internal-connection-point
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']/vnfd:internal-connection-point[vnfd:id-ref='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/internal-connection-point/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld/vnfd:internal-connection-point
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']/vnfd:internal-connection-point[vnfd:id-ref='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.InternalVld.InternalConnectionPoint
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__InternalVld__InternalConnectionPoint
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint
Vnfd_data_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint

Fields
NameTypeDescription
id-refLEAFREFreference to the internal connection point id

vnfd:provider-network

Container for the provider network.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld/vnfd:provider-network
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']/vnfd:provider-network
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/provider-network
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:internal-vld/vnfd:provider-network
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:internal-vld[vnfd:id='STRING']/vnfd:provider-network
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.InternalVld.ProviderNetwork
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__InternalVld__ProviderNetwork
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork
Vnfd_data_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork

Fields
NameTypeDescription
physical-networkSTRINGName of the physical network on which the provider network is built.
overlay-typeENUMType of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels
segmentation_idUINT32ID of segregated virtual networks

vnfd:ip-profiles

List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.IpProfiles
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_IpProfiles
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__IpProfiles
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles
Vnfd_data_VnfdCatalog_Vnfd_IpProfiles
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles

Fields
NameTypeDescription
nameSTRINGName of the IP-Profile
descriptionSTRINGDescription for IP profile
ip-profile-paramsCONTAINER

vnfd:ip-profile-params

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams
Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams

Fields
NameTypeDescription
ip-versionENUM
subnet-addressUNIONSubnet IP prefix associated with IP Profile
gateway-addressUNIONIP Address of the default gateway associated with IP Profile
security-groupSTRINGName of the security group
dns-serverLIST
dhcp-paramsCONTAINER
subnet-prefix-poolSTRINGVIM Specific reference to pre-created subnet prefix

vnfd:dns-server

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params/vnfd:dns-server
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params/vnfd:dns-server[vnfd:address='UNION_VALUE']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params/vnfd:dns-server
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params/vnfd:dns-server[vnfd:address='UNION_VALUE']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams.DnsServer
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams__DnsServer
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer
Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer

Fields
NameTypeDescription
addressUNIONList of DNS Servers associated with IP Profile

vnfd:dhcp-params

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params/vnfd:dhcp-params
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params/vnfd:dhcp-params
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:ip-profiles/vnfd:ip-profile-params/vnfd:dhcp-params
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:ip-profiles[vnfd:name='STRING']/vnfd:ip-profile-params/vnfd:dhcp-params
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams.DhcpParams
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams__DhcpParams
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams
Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams

Fields
NameTypeDescription
enabledBOOLEANThis flag indicates if DHCP is enabled or not
start-addressUNIONStart IP address of the IP-Address range associated with DHCP domain
countUINT32Size of the DHCP pool associated with DHCP domain

vnfd:connection-point

List for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:connection-point
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:connection-point[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/connection-point/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:connection-point
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:connection-point[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.ConnectionPoint
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_ConnectionPoint
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__ConnectionPoint
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_ConnectionPoint
Vnfd_data_VnfdCatalog_Vnfd_ConnectionPoint
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_ConnectionPoint

Fields
NameTypeDescription
nameSTRINGName of the connection point
idSTRINGIdentifier for the internal connection points
short-nameSTRINGShort name to appear as label in the UI
typeENUMType of the connection point.
port-security-enabledBOOLEANEnables the port security for the port

vnfd:vdu

List of Virtual Deployment Units

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu
Vnfd_data_VnfdCatalog_Vnfd_Vdu
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu

Fields
NameTypeDescription
idSTRINGUnique id for the VDU
nameSTRINGUnique name for the VDU
descriptionSTRINGDescription of the VDU.
countUINT64Number of instances of VDU
mgmt-vpciSTRINGSpecifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
vm-flavorCONTAINER
guest-epaCONTAINER
vswitch-epaCONTAINER
hypervisor-epaCONTAINER
host-epaCONTAINERSpecifies the host level EPA attributes.
alarmLIST
imageSTRINGImage name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksumSTRINGImage md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
cloud-initSTRINGContents of cloud-init script, provided inline, in cloud-config format
cloud-init-fileSTRINGName of file with contents of cloud-init script in cloud-config format
supplemental-boot-dataCONTAINER
internal-connection-pointLISTList for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.
internal-interfaceLISTList of internal interfaces for the VNF
external-interfaceLISTList of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.
volumesLIST

vnfd:vm-flavor

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vm-flavor
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vm-flavor
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vm-flavor
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vm-flavor
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vm-flavor
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VmFlavor
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VmFlavor
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VmFlavor
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VmFlavor
Vnfd_data_VnfdCatalog_Vnfd_Vdu_VmFlavor
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VmFlavor

Fields
NameTypeDescription
vcpu-countUINT16Number of VCPUs for the VM.
memory-mbUINT64Amount of memory in MB.
storage-gbUINT64Amount of disk space in GB.

vnfd:guest-epa

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa

Fields
NameTypeDescription
trusted-executionBOOLEANThis VM should be allocated from trusted pool
mempage-sizeENUMMemory page allocation size. If a VM requires hugepages, it should choose LARGE or SIZE_2MB or SIZE_1GB. If the VM prefers hugepages it should choose PREFER_LARGE. LARGE : Require hugepages (either 2MB or 1GB) SMALL : Doesn't require hugepages SIZE_2MB : Requires 2MB hugepages SIZE_1GB : Requires 1GB hugepages PREFER_LARGE : Application prefers hugepages
cpu-pinning-policyENUMCPU pinning policy describes association between virtual CPUs in guest and the physical CPUs in the host. DEDICATED : Virtual CPUs are pinned to physical CPUs SHARED : Multiple VMs may share the same physical CPUs. ANY : Any policy is acceptable for the VM
cpu-thread-pinning-policyENUMCPU thread pinning policy describes how to place the guest CPUs when the host supports hyper threads: AVOID : Avoids placing a guest on a host with threads. SEPARATE: Places vCPUs on separate cores, and avoids placing two vCPUs on two threads of same core. ISOLATE : Places each vCPU on a different core, and places no vCPUs from a different guest on the same core. PREFER : Attempts to place vCPUs on threads of the same core.
pcie-deviceLISTList of pcie passthrough devices.
numa-unawareEMPTY
numa-node-policyCONTAINERThis policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.

vnfd:pcie-device

List of pcie passthrough devices.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:pcie-device
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:pcie-device[vnfd:device-id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/pcie-device/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:pcie-device
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:pcie-device[vnfd:device-id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.PcieDevice
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__PcieDevice
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice

Fields
NameTypeDescription
device-idSTRINGDevice identifier.
countUINT64Number of devices to attach to the VM.

vnfd:numa-node-policy

This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy

Fields
NameTypeDescription
node-cntUINT16The number of NUMA nodes to expose to the VM.
mem-policyENUMThis policy specifies how the memory should be allocated in a multi-node scenario. STRICT : The memory must be allocated strictly from the memory attached to the NUMA node. PREFERRED : The memory should be allocated preferentially from the memory attached to the NUMA node
nodeLIST

vnfd:node

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node

Fields
NameTypeDescription
idUINT64NUMA node identification. Typically it's 0 or 1
vcpuLISTList of VCPUs to allocate on this NUMA node.
memory-mbUINT64Memory size expressed in MB for this NUMA node.
num-coresUINT8
paired-threadsCONTAINER
num-threadsUINT8

vnfd:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:vcpu
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:vcpu[vnfd:id='0']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/vcpu/0
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:vcpu
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:vcpu[vnfd:id='0']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.Vcpu
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__Vcpu
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu

Fields
NameTypeDescription
idUINT64List of VCPUs ids to allocate on this NUMA node

vnfd:paired-threads

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:paired-threads
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:paired-threads
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:paired-threads
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:paired-threads
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads

Fields
NameTypeDescription
num-paired-threadsUINT8
paired-thread-idsLISTList of thread pairs to use in case of paired-thread NUMA

vnfd:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:paired-threads/vnfd:paired-thread-ids
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:paired-threads/vnfd:paired-thread-ids[vnfd:thread-a='0']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node/vnfd:paired-threads/vnfd:paired-thread-ids
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:guest-epa/vnfd:numa-node-policy/vnfd:node[vnfd:id='0']/vnfd:paired-threads/vnfd:paired-thread-ids[vnfd:thread-a='0']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads.PairedThreadIds
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads__PairedThreadIds
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds
Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds

Fields
NameTypeDescription
thread-aUINT8
thread-bUINT8

vnfd:vswitch-epa

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vswitch-epa
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vswitch-epa
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vswitch-epa
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vswitch-epa
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vswitch-epa
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VswitchEpa
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VswitchEpa
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VswitchEpa
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VswitchEpa
Vnfd_data_VnfdCatalog_Vnfd_Vdu_VswitchEpa
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VswitchEpa

Fields
NameTypeDescription
ovs-accelerationENUMSpecifies Open vSwitch acceleration mode. MANDATORY: OVS acceleration is required PREFERRED: OVS acceleration is preferred
ovs-offloadENUMSpecifies Open vSwitch hardware offload mode. MANDATORY: OVS offload is required PREFERRED: OVS offload is preferred

vnfd:hypervisor-epa

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:hypervisor-epa
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:hypervisor-epa
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/hypervisor-epa
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:hypervisor-epa
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:hypervisor-epa
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.HypervisorEpa
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_HypervisorEpa
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__HypervisorEpa
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HypervisorEpa
Vnfd_data_VnfdCatalog_Vnfd_Vdu_HypervisorEpa
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HypervisorEpa

Fields
NameTypeDescription
typeENUMSpecifies the type of hypervisor. KVM: KVM XEN: XEN
versionSTRING

vnfd:host-epa

Specifies the host level EPA attributes.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.HostEpa
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_HostEpa
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__HostEpa
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa
Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa

Fields
NameTypeDescription
cpu-modelENUMHost CPU model. Examples include: SandyBridge, IvyBridge
cpu-archENUMHost CPU architecture.
cpu-vendorENUMHost CPU Vendor.
cpu-socket-countUINT64Number of sockets on the host.
cpu-core-countUINT64Number of cores on the host.
cpu-core-thread-countUINT64Number of threads per cores on the host.
cpu-featureLISTList of CPU features.
om-cpu-model-stringSTRINGOpenMANO CPU model string
om-cpu-featureLISTList of OpenMANO CPU features

vnfd:cpu-feature

List of CPU features.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa/vnfd:cpu-feature
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa/vnfd:cpu-feature[vnfd:feature='PREFER_AES']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/cpu-feature/PREFER_AES
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa/vnfd:cpu-feature
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa/vnfd:cpu-feature[vnfd:feature='PREFER_AES']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.HostEpa.CpuFeature
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__HostEpa__CpuFeature
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature
Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature

Fields
NameTypeDescription
featureENUMCPU feature.

vnfd:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa/vnfd:om-cpu-feature
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa/vnfd:om-cpu-feature[vnfd:feature='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/om-cpu-feature/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:host-epa/vnfd:om-cpu-feature
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:host-epa/vnfd:om-cpu-feature[vnfd:feature='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.HostEpa.OmCpuFeature
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__HostEpa__OmCpuFeature
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature
Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature

Fields
NameTypeDescription
featureSTRINGCPU feature

vnfd:alarm

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Alarm
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Alarm
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Alarm
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm

Fields
NameTypeDescription
alarm-idSTRINGThis field is reserved for the identifier assigned by the VIM provider
nameSTRINGA human readable string to identify the alarm
descriptionSTRINGA description of this alarm
vdur-idSTRINGThe identifier of the VDUR that the alarm is associated with
actionsCONTAINER
repeatBOOLEANThis flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabledBOOLEANThis flag indicates whether the alarm has been enabled or disabled.
severityENUMA measure of the importance or urgency of the alarm
metricENUMThe metric to be tracked by this alarm.
statisticENUMThe type of metric statistic that is tracked by this alarm
operationENUMThe relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
valueDECIMAL64This value defines the threshold that, if crossed, will trigger the alarm.
periodUINT32The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluationsUINT32Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

vnfd:actions

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Alarm.Actions
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Alarm_Actions
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Alarm__Actions
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions

Fields
NameTypeDescription
okLIST
insufficient-dataLIST
alarmLIST

vnfd:ok

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:ok
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:ok[vnfd:url='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/ok/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:ok
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:ok[vnfd:url='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Alarm.Actions.Ok
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Ok
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Alarm__Actions__Ok
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Ok
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Ok
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Ok

Fields
NameTypeDescription
urlSTRING

vnfd:insufficient-data

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:insufficient-data
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:insufficient-data[vnfd:url='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/insufficient-data/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:insufficient-data
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:insufficient-data[vnfd:url='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Alarm.Actions.InsufficientData
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_InsufficientData
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Alarm__Actions__InsufficientData
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_InsufficientData
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_InsufficientData
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_InsufficientData

Fields
NameTypeDescription
urlSTRING

vnfd:alarm

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:alarm
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:alarm[vnfd:url='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/alarm/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:alarm/vnfd:actions/vnfd:alarm
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:alarm[vnfd:alarm-id='STRING']/vnfd:actions/vnfd:alarm[vnfd:url='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Alarm.Actions.Alarm
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Alarm
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Alarm__Actions__Alarm
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Alarm
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Alarm
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Alarm_Actions_Alarm

Fields
NameTypeDescription
urlSTRING

vnfd:supplemental-boot-data

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:supplemental-boot-data
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:supplemental-boot-data
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:supplemental-boot-data
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:supplemental-boot-data
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.SupplementalBootData
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_SupplementalBootData
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__SupplementalBootData
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData
Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData

Fields
NameTypeDescription
config-fileLISTList of configuration files to be written on an additional drive
boot-data-driveBOOLEANSome VIMs implement additional drives to host config-files or meta-data

vnfd:config-file

List of configuration files to be written on an additional drive

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:supplemental-boot-data/vnfd:config-file
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:supplemental-boot-data/vnfd:config-file[vnfd:source='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data/config-file/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:supplemental-boot-data/vnfd:config-file
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:supplemental-boot-data/vnfd:config-file[vnfd:source='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.SupplementalBootData.ConfigFile
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__SupplementalBootData__ConfigFile
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile
Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile

Fields
NameTypeDescription
sourceSTRINGName of the configuration file
destSTRINGFull path of the destination in the guest

vnfd:internal-connection-point

List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-connection-point
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-connection-point[vnfd:id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/internal-connection-point/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-connection-point
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-connection-point[vnfd:id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.InternalConnectionPoint
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__InternalConnectionPoint
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint
Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint

Fields
NameTypeDescription
nameSTRINGName of the connection point
idSTRINGIdentifier for the internal connection points
short-nameSTRINGShort name to appear as label in the UI
typeENUMType of the connection point.
port-security-enabledBOOLEANEnables the port security for the port

vnfd:internal-interface

List of internal interfaces for the VNF

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-interface
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-interface[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/internal-interface/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-interface
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-interface[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.InternalInterface
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_InternalInterface
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__InternalInterface
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface
Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface

Fields
NameTypeDescription
nameSTRINGName of internal interface. Note that this name has only local significance to the VDU.
vdu-internal-connection-point-refLEAFREF
virtual-interfaceCONTAINERContainer for the virtual interface properties

vnfd:virtual-interface

Container for the virtual interface properties

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-interface/vnfd:virtual-interface
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-interface[vnfd:name='STRING']/vnfd:virtual-interface
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/internal-interface/STRING/virtual-interface
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:internal-interface/vnfd:virtual-interface
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:internal-interface[vnfd:name='STRING']/vnfd:virtual-interface
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.InternalInterface.VirtualInterface
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_InternalInterface_VirtualInterface
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__InternalInterface__VirtualInterface
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface_VirtualInterface
Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface_VirtualInterface
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_InternalInterface_VirtualInterface

Fields
NameTypeDescription
typeENUMSpecifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface. E1000 : Emulate E1000 interface. RTL8139 : Emulate RTL8139 interface. PCNET : Emulate PCNET interface. OM-MGMT : Used to specify openmano mgmt external-connection type
vpciSTRINGSpecifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
bandwidthUINT64Aggregate bandwidth of the NIC.

vnfd:external-interface

List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:external-interface
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:external-interface[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/external-interface/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:external-interface
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:external-interface[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.ExternalInterface
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_ExternalInterface
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__ExternalInterface
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface
Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface

Fields
NameTypeDescription
nameSTRINGName of the external interface. Note that this name has only local significance to the VDU.
vnfd-connection-point-refLEAFREFName of the external connection point.
virtual-interfaceCONTAINERContainer for the virtual interface properties

vnfd:virtual-interface

Container for the virtual interface properties

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:external-interface/vnfd:virtual-interface
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:external-interface[vnfd:name='STRING']/vnfd:virtual-interface
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/external-interface/STRING/virtual-interface
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:external-interface/vnfd:virtual-interface
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:external-interface[vnfd:name='STRING']/vnfd:virtual-interface
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.ExternalInterface.VirtualInterface
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_ExternalInterface_VirtualInterface
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__ExternalInterface__VirtualInterface
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface_VirtualInterface
Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface_VirtualInterface
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_ExternalInterface_VirtualInterface

Fields
NameTypeDescription
typeENUMSpecifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface. E1000 : Emulate E1000 interface. RTL8139 : Emulate RTL8139 interface. PCNET : Emulate PCNET interface. OM-MGMT : Used to specify openmano mgmt external-connection type
vpciSTRINGSpecifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
bandwidthUINT64Aggregate bandwidth of the NIC.

vnfd:volumes

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:volumes
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:volumes[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/volumes/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:volumes
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:volumes[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Volumes
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Volumes
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Volumes
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Volumes
Vnfd_data_VnfdCatalog_Vnfd_Vdu_Volumes
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Volumes

Fields
NameTypeDescription
nameSTRINGName of the disk-volumes, e.g. vda, vdb etc
descriptionSTRINGDescription for Volume
sizeUINT64Size of disk in GB
ephemeralEMPTY
imageSTRINGImage name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksumSTRINGImage md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
device-busENUMType of disk-bus on which this disk is exposed to guest
device-typeENUMThe type of device as exposed to guest

vnfd:vdu-dependency

List of VDU dependencies.

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu-dependency
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu-dependency[vnfd:vdu-source-ref='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/vdu-dependency/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu-dependency
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu-dependency[vnfd:vdu-source-ref='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VduDependency
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_VduDependency
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VduDependency
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VduDependency
Vnfd_data_VnfdCatalog_Vnfd_VduDependency
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VduDependency

Fields
NameTypeDescription
vdu-source-refLEAFREF
vdu-depends-on-refLEAFREFReference to the VDU on which the source VDU depends.

vnfd:http-endpoint

List of http endpoints to be used by monitoring params

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:http-endpoint
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:http-endpoint[vnfd:path='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/http-endpoint/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:http-endpoint
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:http-endpoint[vnfd:path='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.HttpEndpoint
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_HttpEndpoint
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__HttpEndpoint
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint
Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint

Fields
NameTypeDescription
pathSTRINGThe HTTP path on the management server
httpsBOOLEANPick HTTPS instead of HTTP , Default is false
portUINT16The HTTP port to connect to
usernameSTRINGThe HTTP basic auth username
passwordSTRINGThe HTTP basic auth password
polling-interval-secsUINT8The HTTP polling interval in seconds
methodENUMMethod that the URI should perform. Deafult action is GET.
headersLISTCustom HTTP headers to put on HTTP request

vnfd:headers

Custom HTTP headers to put on HTTP request

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:http-endpoint/vnfd:headers
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:http-endpoint[vnfd:path='STRING']/vnfd:headers[vnfd:key='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/http-endpoint/STRING/headers/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:http-endpoint/vnfd:headers
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:http-endpoint[vnfd:path='STRING']/vnfd:headers[vnfd:key='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.HttpEndpoint.Headers
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_HttpEndpoint_Headers
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__HttpEndpoint__Headers
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint_Headers
Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint_Headers
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_HttpEndpoint_Headers

Fields
NameTypeDescription
keySTRINGHTTP header key
valueSTRINGHTTP header value

vnfd:monitoring-param

List of monitoring parameters at the network service level

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MonitoringParam
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MonitoringParam
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MonitoringParam
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam
Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam

Fields
NameTypeDescription
idSTRING
nameSTRING
http-endpoint-refLEAFREF
json-query-methodENUM
json-query-paramsCONTAINER
descriptionSTRING
group-tagSTRINGA tag to group monitoring parameters
widget-typeENUMDefines the UI Display variant of measured counters.
unitsSTRINGMeasured Counter Units (e.g., Packets, Kbps, Mbps, etc.)
value-typeENUM
numeric-constraintsCONTAINER
text-constraintsCONTAINER
value-integerINT64Current value for an integer parameter
value-decimalDECIMAL64Current value for a decimal parameter
value-stringSTRINGCurrent value for a string parameter

vnfd:json-query-params

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:json-query-params
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:json-query-params
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/json-query-params
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:json-query-params
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:json-query-params
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MonitoringParam.JsonQueryParams
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MonitoringParam__JsonQueryParams
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams
Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams

Fields
NameTypeDescription
json-pathSTRINGThe jsonpath to use to extract value from JSON structure
object-pathSTRINGThe objectpath to use to extract value from JSON structure

vnfd:numeric-constraints

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:numeric-constraints
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:numeric-constraints
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/numeric-constraints
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:numeric-constraints
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:numeric-constraints
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MonitoringParam.NumericConstraints
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MonitoringParam__NumericConstraints
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints
Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints

Fields
NameTypeDescription
min-valueUINT64Minimum value for the parameter
max-valueUINT64Maximum value for the parameter

vnfd:text-constraints

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:text-constraints
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:text-constraints
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/text-constraints
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:monitoring-param/vnfd:text-constraints
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:monitoring-param[vnfd:id='STRING']/vnfd:text-constraints
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.MonitoringParam.TextConstraints
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__MonitoringParam__TextConstraints
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints
Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints

Fields
NameTypeDescription
min-lengthUINT8Minimum string length for the parameter
max-lengthUINT8Maximum string length for the parameter

vnfd:placement-groups

List of placement groups at VNF level

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:placement-groups
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:placement-groups[vnfd:name='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:placement-groups
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:placement-groups[vnfd:name='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.PlacementGroups
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_PlacementGroups
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__PlacementGroups
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups
Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups

Fields
NameTypeDescription
nameSTRINGPlace group construct to define the compute resource placement strategy in cloud environment
requirementSTRINGThis is free text space used to describe the intent/rationale behind this placement group. This is for human consumption only
strategyENUMStrategy associated with this placement group Following values are possible - COLOCATION: Colocation strategy imply intent to share the physical infrastructure (hypervisor/network) among all members of this group. - ISOLATION: Isolation strategy imply intent to not share the physical infrastructure (hypervisor/network) among the members of this group.
member-vdusLISTList of VDUs that are part of this placement group

vnfd:member-vdus

List of VDUs that are part of this placement group

Key Identifiers:
XPath Path
/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:placement-groups/vnfd:member-vdus
XPath Keyed Path
/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:placement-groups[vnfd:name='STRING']/vnfd:member-vdus[vnfd:member-vdu-ref='STRING']
RW.REST URI Path
/vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING/member-vdus/STRING
RW Keyspec XPath Path
C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:placement-groups/vnfd:member-vdus
RW Keyspec XPath Keyed Path
C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:placement-groups[vnfd:name='STRING']/vnfd:member-vdus[vnfd:member-vdu-ref='STRING']
Protobuf Type
.vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.PlacementGroups.MemberVdus
Python Proto-GI Type
VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus
C Protobuf-C Struct Type
Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__PlacementGroups__MemberVdus
C RWPB Identifiers
Vnfd_Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus
Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus
YPBC Base Identifier
rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus

Fields
NameTypeDescription
member-vdu-refLEAFREF