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
| Name | Type | Description |
|---|---|---|
| vnfd | LIST |
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
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VNFD. |
| name | STRING | VNFD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Vendor of the VNFD. |
| logo | STRING | Vendor logo for the Virtual Network Function |
| description | STRING | Description of the VNFD. |
| version | STRING | Version of the VNFD |
| vnf-configuration | CONTAINER | |
| mgmt-interface | CONTAINER | Interface over which the VNF is managed. |
| internal-vld | LIST | 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. |
| ip-profiles | LIST | List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link |
| connection-point | LIST | 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. |
| vdu | LIST | List of Virtual Deployment Units |
| vdu-dependency | LIST | List of VDU dependencies. |
| service-function-chain | ENUM | Type of node in Service Function Chaining Architecture |
| service-function-type | STRING | Type 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-endpoint | LIST | List of http endpoints to be used by monitoring params |
| monitoring-param | LIST | List of monitoring parameters at the network service level |
| placement-groups | LIST | List of placement groups at VNF level |
vnfd:vnf-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.YangData_Vnfd_VnfdCatalog_Vnfd_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 |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration |
Fields
| Name | Type | Description |
|---|---|---|
| script | CONTAINER | |
| juju | CONTAINER | |
| config-primitive | LIST | List of config primitives supported by the configuration agent for this VNF or VDU. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
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.YangData_Vnfd_VnfdCatalog_Vnfd_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 |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported - Scripts confirming to Rift CA plugin |
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.YangData_Vnfd_VnfdCatalog_Vnfd_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 |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF or VDU. |
| vca-relationships | CONTAINER |
vnfd:vca-relationships
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju/vca-relationships |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Juju.VcaRelationships |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Juju__VcaRelationships |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships |
Fields
| Name | Type | Description |
|---|---|---|
| relation | LIST | List of relations between VCA componets. |
vnfd:relation
List of relations between VCA componets.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation[vnfd:requires='STRING'][vnfd:provides='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju/vca-relationships/relation/STRING,STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation[vnfd:requires='STRING'][vnfd:provides='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.Juju.VcaRelationships.Relation |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships_Relation |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__Juju__VcaRelationships__Relation |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships_Relation Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships_Relation |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_Juju_VcaRelationships_Relation |
Fields
| Name | Type | Description |
|---|---|---|
| requires | STRING | Name of the required relation. |
| provides | STRING | Name of the provided relation. |
vnfd:config-primitive
List of config primitives supported by the configuration agent for this VNF or VDU.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-primitive |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-primitive[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-primitive |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-primitive[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ConfigPrimitive |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ConfigPrimitive |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the config primitive. |
| parameter | LIST | List of parameters to the config primitive. |
| user-defined-script | STRING | A user defined script. If user defined script is defined, the script will be executed using bash |
vnfd:parameter
List of parameters to the config primitive.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-primitive/vnfd:parameter |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vnf-configuration/vnfd:config-primitive/vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vnf-configuration/vnfd:config-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.VnfConfiguration.ConfigPrimitive.Parameter |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__VnfConfiguration__ConfigPrimitive__Parameter |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The 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.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_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 |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| parameter | LIST | List of parameters to the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
vnfd:parameter
List of parameters to the configuration primitive.
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.YangData_Vnfd_VnfdCatalog_Vnfd_VnfConfiguration_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 |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| value | STRING | Value associated with the name. |
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
| Name | Type | Description |
|---|---|---|
| ip-address | UNION | |
| vdu-id | LEAFREF | |
| cp | LEAFREF | |
| port | UINT16 | Port for the management interface. |
| dashboard-params | CONTAINER | Parameters 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
| Name | Type | Description |
|---|---|---|
| path | STRING | The HTTP path for the dashboard |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The 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
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VLD |
| name | STRING | Name of the internal VLD |
| short-name | STRING | Short name to appear as label in the UI |
| description | STRING | |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| internal-connection-point | LIST | List of internal connection points in this VLD |
| provider-network | CONTAINER | Container for the provider network. |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account. |
| ip-profile-ref | STRING | Named 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
| Name | Type | Description |
|---|---|---|
| id-ref | LEAFREF | reference 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
| Name | Type | Description |
|---|---|---|
| physical-network | STRING | Name of the physical network on which the provider network is built. |
| segmentation_id | UINT32 | ID 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
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER |
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
| Name | Type | Description |
|---|---|---|
| ip-version | ENUM | |
| subnet-address | UNION | Subnet IP prefix associated with IP Profile |
| gateway-address | UNION | IP Address of the default gateway associated with IP Profile |
| security-group | STRING | Name of the security group |
| dns-server | LIST | |
| dhcp-params | CONTAINER | |
| subnet-prefix-pool | STRING | VIM 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
| Name | Type | Description |
|---|---|---|
| address | UNION | List 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
| Name | Type | Description |
|---|---|---|
| enabled | BOOLEAN | This flag indicates if DHCP is enabled or not |
| start-address | UNION | Start IP address of the IP-Address range associated with DHCP domain |
| count | UINT32 | Size 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
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables 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
| Name | Type | Description |
|---|---|---|
| id | STRING | Unique id for the VDU |
| name | STRING | Unique name for the VDU |
| description | STRING | Description of the VDU. |
| count | UINT64 | Number of instances of VDU |
| mgmt-vpci | STRING | Specifies 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-flavor | CONTAINER | |
| guest-epa | CONTAINER | |
| vswitch-epa | CONTAINER | |
| hypervisor-epa | CONTAINER | |
| host-epa | CONTAINER | Specifies the host level EPA attributes. |
| alarm | LIST | |
| image | STRING | Image 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-checksum | STRING | Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL. |
| vdu-configuration | CONTAINER | |
| cloud-init | STRING | Contents of cloud-init script, provided inline, in cloud-config format |
| cloud-init-file | STRING | Name of file with contents of cloud-init script in cloud-config format |
| supplemental-boot-data | CONTAINER | |
| internal-connection-point | LIST | 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. |
| interface | LIST | List of Interfaces (external and internal) for the VNF |
| volumes | LIST |
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
| Name | Type | Description |
|---|---|---|
| vcpu-count | UINT16 | Number of VCPUs for the VM. |
| memory-mb | UINT64 | Amount of memory in MB. |
| storage-gb | UINT64 | Amount 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
| Name | Type | Description |
|---|---|---|
| trusted-execution | BOOLEAN | This VM should be allocated from trusted pool |
| mempage-size | ENUM | Memory 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-policy | ENUM | CPU 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-policy | ENUM | CPU 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-device | LIST | List of pcie passthrough devices. |
| numa-unaware | EMPTY | |
| numa-node-policy | CONTAINER | 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. |
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
| Name | Type | Description |
|---|---|---|
| device-id | STRING | Device identifier. |
| count | UINT64 | Number 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
| Name | Type | Description |
|---|---|---|
| node-cnt | UINT16 | The number of NUMA nodes to expose to the VM. |
| mem-policy | ENUM | This 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 |
| node | LIST |
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
| Name | Type | Description |
|---|---|---|
| id | UINT64 | NUMA node identification. Typically it's 0 or 1 |
| vcpu | LIST | List of VCPUs to allocate on this NUMA node. |
| memory-mb | UINT64 | Memory size expressed in MB for this NUMA node. |
| num-cores | UINT8 | |
| paired-threads | CONTAINER | |
| num-threads | UINT8 |
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
| Name | Type | Description |
|---|---|---|
| id | UINT64 | List 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
| Name | Type | Description |
|---|---|---|
| num-paired-threads | UINT8 | |
| paired-thread-ids | LIST | List 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
| Name | Type | Description |
|---|---|---|
| thread-a | UINT8 | |
| thread-b | UINT8 |
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
| Name | Type | Description |
|---|---|---|
| ovs-acceleration | ENUM | Specifies Open vSwitch acceleration mode. MANDATORY: OVS acceleration is required PREFERRED: OVS acceleration is preferred |
| ovs-offload | ENUM | Specifies 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
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies the type of hypervisor. KVM: KVM XEN: XEN |
| version | STRING |
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
| Name | Type | Description |
|---|---|---|
| cpu-model | ENUM | Host CPU model. Examples include: SandyBridge, IvyBridge |
| cpu-arch | ENUM | Host CPU architecture. |
| cpu-vendor | ENUM | Host CPU Vendor. |
| cpu-socket-count | UINT64 | Number of sockets on the host. |
| cpu-core-count | UINT64 | Number of cores on the host. |
| cpu-core-thread-count | UINT64 | Number of threads per cores on the host. |
| cpu-feature | LIST | List of CPU features. |
| om-cpu-model-string | STRING | OpenMANO CPU model string |
| om-cpu-feature | LIST | List 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
| Name | Type | Description |
|---|---|---|
| feature | ENUM | CPU 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
| Name | Type | Description |
|---|---|---|
| feature | STRING | CPU 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
| Name | Type | Description |
|---|---|---|
| alarm-id | STRING | This field is reserved for the identifier assigned by the VIM provider |
| name | STRING | A human readable string to identify the alarm |
| description | STRING | A description of this alarm |
| vdur-id | STRING | The identifier of the VDUR that the alarm is associated with |
| actions | CONTAINER | |
| repeat | BOOLEAN | This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed. |
| enabled | BOOLEAN | This flag indicates whether the alarm has been enabled or disabled. |
| severity | ENUM | A measure of the importance or urgency of the alarm |
| metric | ENUM | The metric to be tracked by this alarm. |
| statistic | ENUM | The type of metric statistic that is tracked by this alarm |
| operation | ENUM | The 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. |
| value | DECIMAL64 | This value defines the threshold that, if crossed, will trigger the alarm. |
| period | UINT32 | The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic. |
| evaluations | UINT32 | Defines 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
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
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
| Name | Type | Description |
|---|---|---|
| url | STRING |
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
| Name | Type | Description |
|---|---|---|
| url | STRING |
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
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfd:vdu-configuration
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration |
Fields
| Name | Type | Description |
|---|---|---|
| script | CONTAINER | |
| juju | CONTAINER | |
| config-primitive | LIST | List of config primitives supported by the configuration agent for this VNF or VDU. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
vnfd:script
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:script |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:script |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/script |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:script |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:script |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.Script |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Script |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__Script |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Script Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Script |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported - Scripts confirming to Rift CA plugin |
vnfd:juju
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.Juju |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__Juju |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF or VDU. |
| vca-relationships | CONTAINER |
vnfd:vca-relationships
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju/vca-relationships |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.Juju.VcaRelationships |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__Juju__VcaRelationships |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships |
Fields
| Name | Type | Description |
|---|---|---|
| relation | LIST | List of relations between VCA componets. |
vnfd:relation
List of relations between VCA componets.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation[vnfd:requires='STRING'][vnfd:provides='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju/vca-relationships/relation/STRING,STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:juju/vnfd:vca-relationships/vnfd:relation[vnfd:requires='STRING'][vnfd:provides='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.Juju.VcaRelationships.Relation |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships_Relation |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__Juju__VcaRelationships__Relation |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships_Relation Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships_Relation |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_Juju_VcaRelationships_Relation |
Fields
| Name | Type | Description |
|---|---|---|
| requires | STRING | Name of the required relation. |
| provides | STRING | Name of the provided relation. |
vnfd:config-primitive
List of config primitives supported by the configuration agent for this VNF or VDU.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:config-primitive |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:config-primitive[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/config-primitive/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:config-primitive |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:config-primitive[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.ConfigPrimitive |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__ConfigPrimitive |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the config primitive. |
| parameter | LIST | List of parameters to the config primitive. |
| user-defined-script | STRING | A user defined script. If user defined script is defined, the script will be executed using bash |
vnfd:parameter
List of parameters to the config primitive.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:config-primitive/vnfd:parameter |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:config-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/config-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:config-primitive/vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:config-primitive[vnfd:name='STRING']/vnfd:parameter[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.ConfigPrimitive.Parameter |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__ConfigPrimitive__Parameter |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive_Parameter Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_ConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The 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:vdu/vnfd:vdu-configuration/vnfd:initial-config-primitive |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:initial-config-primitive[vnfd:seq='0'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/initial-config-primitive/0 |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:initial-config-primitive |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:initial-config-primitive[vnfd:seq='0'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.InitialConfigPrimitive |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__InitialConfigPrimitive |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| parameter | LIST | List of parameters to the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
vnfd:parameter
List of parameters to the configuration primitive.
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:initial-config-primitive/vnfd:parameter |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:initial-config-primitive[vnfd:seq='0']/vnfd:parameter[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/initial-config-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:vdu-configuration/vnfd:initial-config-primitive/vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:vdu-configuration/vnfd:initial-config-primitive[vnfd:seq='0']/vnfd:parameter[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.VduConfiguration.InitialConfigPrimitive.Parameter |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__VduConfiguration__InitialConfigPrimitive__Parameter |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive_Parameter Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_VduConfiguration_InitialConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| value | STRING | Value associated with the name. |
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
| Name | Type | Description |
|---|---|---|
| config-file | LIST | List of configuration files to be written on an additional drive |
| boot-data-drive | BOOLEAN | Some 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
| Name | Type | Description |
|---|---|---|
| source | STRING | Name of the configuration file |
| dest | STRING | Full 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
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
| internal-vld-ref | LEAFREF |
vnfd:interface
List of Interfaces (external and internal) for the VNF
Key Identifiers:| XPath Path | /vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:interface |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:interface[vnfd:name='STRING'] |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:interface |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:interface[vnfd:name='STRING'] |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Interface |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Interface |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Interface |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the interface. Note that this name has only local significance to the VDU. |
| position | UINT32 | Explicit Position of the interface within the list |
| type | ENUM | Type of the Interface |
| internal-connection-point-ref | LEAFREF | Leaf Ref to the particular internal connection point |
| external-connection-point-ref | LEAFREF | Leaf Ref to the particular external connection point |
| virtual-interface | CONTAINER | Container 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:interface/vnfd:virtual-interface |
| XPath Keyed Path | /vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:interface[vnfd:name='STRING']/vnfd:virtual-interface |
| RW.REST URI Path | /vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING/virtual-interface |
| RW Keyspec XPath Path | C,/vnfd:vnfd-catalog/vnfd:vnfd/vnfd:vdu/vnfd:interface/vnfd:virtual-interface |
| RW Keyspec XPath Keyed Path | C,/vnfd:vnfd-catalog/vnfd:vnfd[vnfd:id='STRING']/vnfd:vdu[vnfd:id='STRING']/vnfd:interface[vnfd:name='STRING']/vnfd:virtual-interface |
| Protobuf Type | .vnfd.YangData.Vnfd.VnfdCatalog.Vnfd.Vdu.Interface.VirtualInterface |
| Python Proto-GI Type | VnfdYang.YangData_Vnfd_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
| C Protobuf-C Struct Type | Vnfd__YangData__Vnfd__VnfdCatalog__Vnfd__Vdu__Interface__VirtualInterface |
| C RWPB Identifiers | Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_Vnfd_Vnfd_data_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
Fields
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies 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 |
| vpci | STRING | Specifies 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. |
| bandwidth | UINT64 | Aggregate 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
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the disk-volumes, e.g. vda, vdb etc |
| description | STRING | Description for Volume |
| size | UINT64 | Size of disk in GB |
| ephemeral | EMPTY | |
| image | STRING | Image 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-checksum | STRING | Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL. |
| device-bus | ENUM | Type of disk-bus on which this disk is exposed to guest |
| device-type | ENUM | The 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
| Name | Type | Description |
|---|---|---|
| vdu-source-ref | LEAFREF | |
| vdu-depends-on-ref | LEAFREF | Reference 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
| Name | Type | Description |
|---|---|---|
| path | STRING | The HTTP path on the management server |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The HTTP port to connect to |
| username | STRING | The HTTP basic auth username |
| password | STRING | The HTTP basic auth password |
| polling-interval-secs | UINT8 | The HTTP polling interval in seconds |
| method | ENUM | Method that the URI should perform. Deafult action is GET. |
| headers | LIST | Custom 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
| Name | Type | Description |
|---|---|---|
| key | STRING | HTTP header key |
| value | STRING | HTTP 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
| Name | Type | Description |
|---|---|---|
| id | STRING | |
| name | STRING | |
| http-endpoint-ref | LEAFREF | |
| json-query-method | ENUM | |
| json-query-params | CONTAINER | |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameters |
| widget-type | ENUM | Defines the UI Display variant of measured counters. |
| units | STRING | Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.) |
| value-type | ENUM | |
| numeric-constraints | CONTAINER | |
| text-constraints | CONTAINER | |
| value-integer | INT64 | Current value for an integer parameter |
| value-decimal | DECIMAL64 | Current value for a decimal parameter |
| value-string | STRING | Current 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
| Name | Type | Description |
|---|---|---|
| json-path | STRING | The jsonpath to use to extract value from JSON structure |
| object-path | STRING | The 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
| Name | Type | Description |
|---|---|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum 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
| Name | Type | Description |
|---|---|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum 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
| Name | Type | Description |
|---|---|---|
| name | STRING | Place group construct to define the compute resource placement strategy in cloud environment |
| requirement | STRING | This is free text space used to describe the intent/rationale behind this placement group. This is for human consumption only |
| strategy | ENUM | Strategy 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-vdus | LIST | List 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
| Name | Type | Description |
|---|---|---|
| member-vdu-ref | LEAFREF |