vnfr - Programmers API Reference
Schema Globals
| Global Schema Type | rw_ypbc_Vnfr_Vnfr_t_schema |
| Global Schema Pointer | rw_ypbc_Vnfr_Vnfr_g_schema |
vnfr data
vnfr:vnfr-catalog
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog |
| XPath Keyed Path | /vnfr:vnfr-catalog |
| RW.REST URI Path | /vnfr:vnfr-catalog |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog Vnfr_data_VnfrCatalog |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog |
Fields
| Name | Type | Description |
|---|---|---|
| vnfr | LIST | Virtual Network Function Record (VNFR). |
vnfr:vnfr
Virtual Network Function Record (VNFR).
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr Vnfr_data_VnfrCatalog_Vnfr |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VNFR. |
| nsr-id-ref | STRING | NS instance identifier. This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id |
| member-vnf-index-ref | LEAFREF | Reference to member VNF index in Network service. |
| dashboard-url | STRING | Dashboard URL |
| name | STRING | VNFR name. |
| short-name | STRING | VNFR short name. |
| vendor | STRING | Vendor of the VNFR. |
| description | STRING | Description of the VNFR. |
| version | STRING | Version of the VNFR |
| create-time | UINT32 | Creation timestamp of this Virtual Network Function. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z |
| uptime | UINT32 | Active period of this Virtual Network Function. Uptime is expressed in seconds |
| vnfd | CONTAINER | VNF descriptor used to instantiate this VNF |
| vnf-configuration | CONTAINER | Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration. |
| mgmt-interface | CONTAINER | |
| internal-vlr | LIST | |
| connection-point | LIST | List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator 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. |
| vdur | LIST | List of Virtual Deployment Units |
| 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 |
| operational-status | ENUM | The operational status of the VNFR instance init : The VNF has just started. vl-init-phase : The internal VLs in the VNF are being instantiated. vm-init-phase : The VMs for VDUs in the VNF are being instantiated. running : The VNF is in running state. terminate : The VNF is being terminated. vm-terminate-phase : The VMs in the VNF are being terminated. vl-terminate-phase : The internal VLs in the VNF are being terminated. terminated : The VNF is in the terminated state. failed : The VNF instantiation failed |
| config-status | ENUM | The configuration status of the NS instance configuring: At least one of the VNFs in this instance is in configuring state configured: All the VNFs in this NS instance are configured or config-not-needed state |
| placement-groups-info | LIST | Placement groups to which this VDU belongs and its cloud construct |
vnfr:vnfd
VNF descriptor used to instantiate this VNF
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd Vnfr_data_VnfrCatalog_Vnfr_Vnfd |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 | Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration. |
| 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 |
vnfr:vnf-configuration
Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration |
Fields
| Name | Type | Description |
|---|---|---|
| netconf | CONTAINER | |
| rest | CONTAINER | |
| script | CONTAINER | |
| juju | CONTAINER | |
| config-access | CONTAINER | |
| config-attributes | CONTAINER | Miscellaneous input parameters to be considered while processing the NSD to apply configuration |
| service-primitive | LIST | List of service primitives supported by the configuration agent for this VNF. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
| config-template | STRING | Configuration template for each VNF |
vnfr:netconf
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/netconf |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.Netconf |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Netconf |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__Netconf |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Netconf Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Netconf |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Netconf |
Fields
| Name | Type | Description |
|---|---|---|
| target | ENUM | Netconf configuration target |
| protocol | ENUM | Protocol to use for NETCONF, such as ssh |
| port | UINT16 | Port for the NETCONF server. |
vnfr:rest
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/rest |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.Rest |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Rest |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__Rest |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Rest Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Rest |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Rest |
Fields
| Name | Type | Description |
|---|---|---|
| port | UINT16 | Port for the REST server. |
vnfr:script
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/script |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.Script |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Script |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__Script |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Script Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Script |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported : bash, expect |
vnfr:juju
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/juju |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.Juju |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Juju |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__Juju |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Juju Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Juju |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_Juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF. |
vnfr:config-access
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/config-access |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.ConfigAccess |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAccess |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__ConfigAccess |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAccess Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAccess |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAccess |
Fields
| Name | Type | Description |
|---|---|---|
| mgmt-ip-address | UNION | IP address to be used to configure this VNF, optional if it is possible to resolve dynamically. |
| username | STRING | User name for configuration. |
| password | STRING | Password for configuration access authentication. |
vnfr:config-attributes
Miscellaneous input parameters to be considered while processing the NSD to apply configuration
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/config-attributes |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.ConfigAttributes |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAttributes |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__ConfigAttributes |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAttributes Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAttributes |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ConfigAttributes |
Fields
| Name | Type | Description |
|---|---|---|
| config-priority | UINT64 | Configuration priority - order of configuration to be applied to each VNF in this NS. A low number takes precedence over a high number |
| config-delay | UINT64 | Wait (seconds) before applying the configuration to VNF |
vnfr:service-primitive
List of service primitives supported by the configuration agent for this VNF.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/service-primitive/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.ServicePrimitive |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__ServicePrimitive |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the service primitive. |
| parameter | LIST | List of parameters to the service primitive. |
vnfr:parameter
List of parameters to the service primitive.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/service-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.ServicePrimitive.Parameter |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__ServicePrimitive__Parameter |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive_Parameter Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_ServicePrimitive_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. |
vnfr:initial-config-primitive
Initial set of configuration primitives.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/initial-config-primitive/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.InitialConfigPrimitive |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__InitialConfigPrimitive |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
| parameter | LIST |
vnfr:parameter
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/initial-config-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VnfConfiguration.InitialConfigPrimitive.Parameter |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VnfConfiguration__InitialConfigPrimitive__Parameter |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
vnfr:mgmt-interface
Interface over which the VNF is managed.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/mgmt-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MgmtInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MgmtInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MgmtInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MgmtInterface Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MgmtInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:dashboard-params
Parameters for the VNF dashboard
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/mgmt-interface/dashboard-params |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MgmtInterface.DashboardParams |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MgmtInterface_DashboardParams |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MgmtInterface__DashboardParams |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MgmtInterface_DashboardParams Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MgmtInterface_DashboardParams |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr: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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-vld/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.InternalVld |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_InternalVld |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__InternalVld |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 | Description of internal VLD. |
| 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 | LEAFREF | Named reference to IP-profile object |
vnfr:internal-connection-point
List of internal connection points in this VLD
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:internal-connection-point |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id-ref='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-vld/STRING/internal-connection-point/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:internal-connection-point |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id-ref='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.InternalVld.InternalConnectionPoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_InternalVld_InternalConnectionPoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__InternalVld__InternalConnectionPoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_InternalConnectionPoint Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_InternalConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_InternalConnectionPoint |
Fields
| Name | Type | Description |
|---|---|---|
| id-ref | LEAFREF | reference to the internal connection point id |
vnfr:provider-network
Container for the provider network.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:provider-network |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:provider-network |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-vld/STRING/provider-network |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:provider-network |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:provider-network |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.InternalVld.ProviderNetwork |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_InternalVld_ProviderNetwork |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__InternalVld__ProviderNetwork |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_ProviderNetwork Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_InternalVld_ProviderNetwork |
Fields
| Name | Type | Description |
|---|---|---|
| physical-network | STRING | Name of the physical network on which the provider network is built. |
| overlay-type | ENUM | Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels |
| segmentation_id | UINT32 | ID of segregated virtual networks |
vnfr:ip-profiles
List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/ip-profiles/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.IpProfiles |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_IpProfiles |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__IpProfiles |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER |
vnfr:ip-profile-params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/ip-profiles/STRING/ip-profile-params |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.IpProfiles.IpProfileParams |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__IpProfiles__IpProfileParams |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:dns-server
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dns-server |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dns-server[vnfr:address='UNION_VALUE'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dns-server |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dns-server[vnfr:address='UNION_VALUE'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.IpProfiles.IpProfileParams.DnsServer |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DnsServer |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__IpProfiles__IpProfileParams__DnsServer |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DnsServer Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|---|---|
| address | UNION | List of DNS Servers associated with IP Profile |
vnfr:dhcp-params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dhcp-params |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dhcp-params |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/ip-profiles/STRING/ip-profile-params/dhcp-params |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dhcp-params |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dhcp-params |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.IpProfiles.IpProfileParams.DhcpParams |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DhcpParams |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__IpProfiles__IpProfileParams__DhcpParams |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DhcpParams Vnfr_data_VnfrCatalog_Vnfr_Vnfd_IpProfiles_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr: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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:connection-point |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:connection-point[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/connection-point/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:connection-point |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:connection-point[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.ConnectionPoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_ConnectionPoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__ConnectionPoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_ConnectionPoint Vnfr_data_VnfrCatalog_Vnfr_Vnfd_ConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:vdu
List of Virtual Deployment Units
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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. |
| 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. |
| internal-interface | LIST | List of internal interfaces for the VNF |
| external-interface | LIST | List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF. |
| volumes | LIST |
vnfr:vm-flavor
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vm-flavor |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vm-flavor |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vm-flavor |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vm-flavor |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vm-flavor |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.VmFlavor |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_VmFlavor |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__VmFlavor |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_VmFlavor Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_VmFlavor |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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. |
vnfr:guest-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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. |
vnfr:pcie-device
List of pcie passthrough devices.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:pcie-device |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/pcie-device/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:pcie-device |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.PcieDevice |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_PcieDevice |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__PcieDevice |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_PcieDevice Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_PcieDevice |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_PcieDevice |
Fields
| Name | Type | Description |
|---|---|---|
| device-id | STRING | Device identifier. |
| count | UINT64 | Number of devices to attach to the VM. |
vnfr: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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.NumaNodePolicy |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__NumaNodePolicy |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:node
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:vcpu
List of VCPUs to allocate on this NUMA node.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/vcpu/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.Vcpu |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__Vcpu |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
Fields
| Name | Type | Description |
|---|---|---|
| id | UINT64 | List of VCPUs ids to allocate on this NUMA node |
vnfr:paired-threads
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:paired-thread-ids
List of thread pairs to use in case of paired-thread NUMA
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads.PairedThreadIds |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads__PairedThreadIds |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
Fields
| Name | Type | Description |
|---|---|---|
| thread-a | UINT8 | |
| thread-b | UINT8 |
vnfr:vswitch-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vswitch-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vswitch-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vswitch-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vswitch-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vswitch-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.VswitchEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_VswitchEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__VswitchEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_VswitchEpa Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_VswitchEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:hypervisor-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:hypervisor-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:hypervisor-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/hypervisor-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:hypervisor-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:hypervisor-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.HypervisorEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_HypervisorEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__HypervisorEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HypervisorEpa Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HypervisorEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HypervisorEpa |
Fields
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies the type of hypervisor. KVM: KVM XEN: XEN |
| version | STRING |
vnfr:host-epa
Specifies the host level EPA attributes.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.HostEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__HostEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:cpu-feature
List of CPU features.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:cpu-feature |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/cpu-feature/PREFER_AES |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:cpu-feature |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.HostEpa.CpuFeature |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_CpuFeature |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__HostEpa__CpuFeature |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_CpuFeature Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_CpuFeature |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_CpuFeature |
Fields
| Name | Type | Description |
|---|---|---|
| feature | ENUM | CPU feature. |
vnfr:om-cpu-feature
List of OpenMANO CPU features
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:om-cpu-feature |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/om-cpu-feature/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:om-cpu-feature |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.HostEpa.OmCpuFeature |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_OmCpuFeature |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__HostEpa__OmCpuFeature |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_OmCpuFeature Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_OmCpuFeature |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_HostEpa_OmCpuFeature |
Fields
| Name | Type | Description |
|---|---|---|
| feature | STRING | CPU feature |
vnfr:alarm
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Alarm |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Alarm |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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. |
vnfr:actions
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Alarm.Actions |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Alarm__Actions |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions |
Fields
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
vnfr:ok
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:ok |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/ok/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:ok |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Alarm.Actions.Ok |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Ok |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Alarm__Actions__Ok |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Ok Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Ok |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Ok |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:insufficient-data
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:insufficient-data |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/insufficient-data/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:insufficient-data |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Alarm.Actions.InsufficientData |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_InsufficientData |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Alarm__Actions__InsufficientData |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_InsufficientData Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_InsufficientData |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_InsufficientData |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:alarm
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:alarm |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/alarm/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:alarm |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Alarm.Actions.Alarm |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Alarm |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Alarm__Actions__Alarm |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Alarm Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Alarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Alarm_Actions_Alarm |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:supplemental-boot-data
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/supplemental-boot-data |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.SupplementalBootData |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__SupplementalBootData |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:config-file
List of configuration files to be written on an additional drive
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data/vnfr:config-file |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/supplemental-boot-data/config-file/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data/vnfr:config-file |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.SupplementalBootData.ConfigFile |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData_ConfigFile |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__SupplementalBootData__ConfigFile |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData_ConfigFile Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_SupplementalBootData_ConfigFile |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr: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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-connection-point |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-connection-point/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-connection-point |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.InternalConnectionPoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalConnectionPoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__InternalConnectionPoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalConnectionPoint Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:internal-interface
List of internal interfaces for the VNF
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-interface/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.InternalInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__InternalInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of internal interface. Note that this name has only local significance to the VDU. |
| vdu-internal-connection-point-ref | LEAFREF | |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
vnfr:virtual-interface
Container for the virtual interface properties
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface/vnfr:virtual-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-interface/STRING/virtual-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface/vnfr:virtual-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.InternalInterface.VirtualInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface_VirtualInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__InternalInterface__VirtualInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface_VirtualInterface Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_InternalInterface_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. |
vnfr:external-interface
List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/external-interface/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.ExternalInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__ExternalInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the external interface. Note that this name has only local significance to the VDU. |
| vnfd-connection-point-ref | LEAFREF | Name of the external connection point. |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
vnfr:virtual-interface
Container for the virtual interface properties
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface/vnfr:virtual-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/external-interface/STRING/virtual-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface/vnfr:virtual-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.ExternalInterface.VirtualInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface_VirtualInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__ExternalInterface__VirtualInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface_VirtualInterface Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_ExternalInterface_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. |
vnfr:volumes
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:volumes |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/volumes/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:volumes |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.Vdu.Volumes |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_Vdu_Volumes |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__Vdu__Volumes |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Volumes Vnfr_data_VnfrCatalog_Vnfr_Vnfd_Vdu_Volumes |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:vdu-dependency
List of VDU dependencies.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu-dependency |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu-dependency[vnfr:vdu-source-ref='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu-dependency/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu-dependency |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu-dependency[vnfr:vdu-source-ref='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.VduDependency |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_VduDependency |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__VduDependency |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VduDependency Vnfr_data_VnfrCatalog_Vnfr_Vnfd_VduDependency |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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. |
vnfr:http-endpoint
List of http endpoints to be used by monitoring params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/http-endpoint/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.HttpEndpoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__HttpEndpoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint Vnfr_data_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:headers
Custom HTTP headers to put on HTTP request
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint/vnfr:headers |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/http-endpoint/STRING/headers/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint/vnfr:headers |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.HttpEndpoint.Headers |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint_Headers |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__HttpEndpoint__Headers |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint_Headers Vnfr_data_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint_Headers |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_HttpEndpoint_Headers |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | HTTP header key |
| value | STRING | HTTP header value |
vnfr:monitoring-param
List of monitoring parameters at the network service level
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MonitoringParam |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MonitoringParam |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MonitoringParam |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:json-query-params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:json-query-params |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING/json-query-params |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:json-query-params |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MonitoringParam.JsonQueryParams |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_JsonQueryParams |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MonitoringParam__JsonQueryParams |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_JsonQueryParams Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_JsonQueryParams |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:numeric-constraints
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:numeric-constraints |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING/numeric-constraints |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:numeric-constraints |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MonitoringParam.NumericConstraints |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_NumericConstraints |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MonitoringParam__NumericConstraints |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_NumericConstraints Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_NumericConstraints |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_NumericConstraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
vnfr:text-constraints
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:text-constraints |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING/text-constraints |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:text-constraints |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.MonitoringParam.TextConstraints |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_TextConstraints |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__MonitoringParam__TextConstraints |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_TextConstraints Vnfr_data_VnfrCatalog_Vnfr_Vnfd_MonitoringParam_TextConstraints |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:placement-groups
List of placement groups at VNF level
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/placement-groups/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.PlacementGroups |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_PlacementGroups |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__PlacementGroups |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_PlacementGroups Vnfr_data_VnfrCatalog_Vnfr_Vnfd_PlacementGroups |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:member-vdus
List of VDUs that are part of this placement group
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups/vnfr:member-vdus |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']/vnfr:member-vdus[vnfr:member-vdu-ref='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnfd/placement-groups/STRING/member-vdus/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups/vnfr:member-vdus |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']/vnfr:member-vdus[vnfr:member-vdu-ref='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vnfd.PlacementGroups.MemberVdus |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd_PlacementGroups_MemberVdus |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vnfd__PlacementGroups__MemberVdus |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_PlacementGroups_MemberVdus Vnfr_data_VnfrCatalog_Vnfr_Vnfd_PlacementGroups_MemberVdus |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vnfd_PlacementGroups_MemberVdus |
Fields
| Name | Type | Description |
|---|---|---|
| member-vdu-ref | LEAFREF |
vnfr:vnf-configuration
Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration |
Fields
| Name | Type | Description |
|---|---|---|
| netconf | CONTAINER | |
| rest | CONTAINER | |
| script | CONTAINER | |
| juju | CONTAINER | |
| config-access | CONTAINER | |
| config-attributes | CONTAINER | Miscellaneous input parameters to be considered while processing the NSD to apply configuration |
| service-primitive | LIST | List of service primitives supported by the configuration agent for this VNF. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
| config-template | STRING | Configuration template for each VNF |
vnfr:netconf
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:netconf |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:netconf |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/netconf |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:netconf |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:netconf |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.Netconf |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_Netconf |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__Netconf |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Netconf Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Netconf |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Netconf |
Fields
| Name | Type | Description |
|---|---|---|
| target | ENUM | Netconf configuration target |
| protocol | ENUM | Protocol to use for NETCONF, such as ssh |
| port | UINT16 | Port for the NETCONF server. |
vnfr:rest
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:rest |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:rest |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/rest |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:rest |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:rest |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.Rest |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_Rest |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__Rest |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Rest Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Rest |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Rest |
Fields
| Name | Type | Description |
|---|---|---|
| port | UINT16 | Port for the REST server. |
vnfr:script
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:script |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:script |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/script |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:script |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:script |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.Script |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_Script |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__Script |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Script Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Script |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported : bash, expect |
vnfr:juju
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/juju |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.Juju |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_Juju |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__Juju |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Juju Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Juju |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_Juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF. |
vnfr:config-access
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-access |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-access |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/config-access |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-access |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-access |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.ConfigAccess |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAccess |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__ConfigAccess |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAccess Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAccess |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAccess |
Fields
| Name | Type | Description |
|---|---|---|
| mgmt-ip-address | UNION | IP address to be used to configure this VNF, optional if it is possible to resolve dynamically. |
| username | STRING | User name for configuration. |
| password | STRING | Password for configuration access authentication. |
vnfr:config-attributes
Miscellaneous input parameters to be considered while processing the NSD to apply configuration
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-attributes |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-attributes |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/config-attributes |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-attributes |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-attributes |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.ConfigAttributes |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAttributes |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__ConfigAttributes |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAttributes Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAttributes |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ConfigAttributes |
Fields
| Name | Type | Description |
|---|---|---|
| config-priority | UINT64 | Configuration priority - order of configuration to be applied to each VNF in this NS. A low number takes precedence over a high number |
| config-delay | UINT64 | Wait (seconds) before applying the configuration to VNF |
vnfr:service-primitive
List of service primitives supported by the configuration agent for this VNF.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/service-primitive/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.ServicePrimitive |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__ServicePrimitive |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the service primitive. |
| parameter | LIST | List of parameters to the service primitive. |
vnfr:parameter
List of parameters to the service primitive.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/service-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.ServicePrimitive.Parameter |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__ServicePrimitive__Parameter |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive_Parameter Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_ServicePrimitive_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. |
vnfr:initial-config-primitive
Initial set of configuration primitives.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/initial-config-primitive/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.InitialConfigPrimitive |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__InitialConfigPrimitive |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
| parameter | LIST |
vnfr:parameter
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/initial-config-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.VnfConfiguration.InitialConfigPrimitive.Parameter |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__VnfConfiguration__InitialConfigPrimitive__Parameter |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive_Parameter Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_VnfConfiguration_InitialConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
vnfr:mgmt-interface
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:mgmt-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:mgmt-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/mgmt-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:mgmt-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:mgmt-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.MgmtInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_MgmtInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__MgmtInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MgmtInterface Vnfr_data_VnfrCatalog_Vnfr_MgmtInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MgmtInterface |
Fields
| Name | Type | Description |
|---|---|---|
| ip-address | UNION | |
| port | UINT16 |
vnfr:internal-vlr
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.InternalVlr |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_InternalVlr |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__InternalVlr |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_InternalVlr Vnfr_data_VnfrCatalog_Vnfr_InternalVlr |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_InternalVlr |
Fields
| Name | Type | Description |
|---|---|---|
| vlr-ref | LEAFREF | Reference to a VLR record in the VLR catalog |
| internal-connection-point-ref | LEAF_LIST |
vnfr:internal-connection-point-ref
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr/vnfr:internal-connection-point-ref |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']/vnfr:internal-connection-point-ref |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING/internal-connection-point-ref |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr/vnfr:internal-connection-point-ref |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']/vnfr:internal-connection-point-ref |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.InternalVlr.InternalConnectionPointRef |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_InternalVlr_InternalConnectionPointRef |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__InternalVlr__InternalConnectionPointRef |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_InternalVlr_InternalConnectionPointRef Vnfr_data_VnfrCatalog_Vnfr_InternalVlr_InternalConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_InternalVlr_InternalConnectionPointRef |
vnfr:connection-point
List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator 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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:connection-point |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:connection-point[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/connection-point/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:connection-point |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:connection-point[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.ConnectionPoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_ConnectionPoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__ConnectionPoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_ConnectionPoint Vnfr_data_VnfrCatalog_Vnfr_ConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
| vlr-ref | LEAFREF | Reference to the VLR associated with this connection point |
| ip-address | UNION | IP address assigned to the external connection point |
| mac-address | STRING | MAC address assigned to the external connection point |
| connection-point-id | STRING |
vnfr:vdur
List of Virtual Deployment Units
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur Vnfr_data_VnfrCatalog_Vnfr_Vdur |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Unique id for the VDU |
| name | STRING | name of the instantiated VDUR |
| unique-short-name | STRING | Short Unique name of the VDU This will be of the format NSR name-ShortnedString-VDUname NSR name and VDU name shall be constrained to 10 characters |
| vdu-id-ref | LEAFREF | |
| vim-id | STRING | Allocated VM resource id |
| flavor-id | STRING | VIM assigned flavor id |
| image-id | STRING | VIM assigned image id |
| management-ip | UNION | Management IP address |
| vm-management-ip | UNION | VM Private Management IP address |
| console-url | STRING | Console URL for this VDU, if available |
| vm-flavor | CONTAINER | |
| guest-epa | CONTAINER | |
| vswitch-epa | CONTAINER | |
| hypervisor-epa | CONTAINER | |
| host-epa | CONTAINER | Specifies the host level EPA attributes. |
| supplemental-boot-data | CONTAINER | |
| volumes | LIST | |
| alarms | LIST | A list of the alarms that have been created for this VDU |
| 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 components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points. |
| internal-interface | LIST | List of internal interfaces for the VNF |
| external-interface | LIST | List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF. |
| operational-status | ENUM | The operational status of the VDU init : The VDU has just started. vm-init-phase : The VDUs in the VNF is being created in VIM. vm-alloc-pending : The VM alloc is pending in VIM running : The VDU is active in VM terminate : The VDU is being terminated vm-terminate-phase : The VDU in the VNF is being terminated in VIM. terminated : The VDU is in the terminated state. failed : The VDU instantiation failed. |
| placement-groups-info | LIST | Placement groups to which this VDU belongs and its cloud construct |
vnfr:vm-flavor
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vm-flavor |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vm-flavor |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vm-flavor |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vm-flavor |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vm-flavor |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.VmFlavor |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_VmFlavor |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__VmFlavor |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_VmFlavor Vnfr_data_VnfrCatalog_Vnfr_Vdur_VmFlavor |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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. |
vnfr:guest-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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. |
vnfr:pcie-device
List of pcie passthrough devices.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:pcie-device |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/pcie-device/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:pcie-device |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.PcieDevice |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_PcieDevice |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__PcieDevice |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_PcieDevice Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_PcieDevice |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_PcieDevice |
Fields
| Name | Type | Description |
|---|---|---|
| device-id | STRING | Device identifier. |
| count | UINT64 | Number of devices to attach to the VM. |
vnfr: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 | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.NumaNodePolicy |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__NumaNodePolicy |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:node
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.NumaNodePolicy.Node |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__NumaNodePolicy__Node |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:vcpu
List of VCPUs to allocate on this NUMA node.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/vcpu/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.NumaNodePolicy.Node.Vcpu |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_Vcpu |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__NumaNodePolicy__Node__Vcpu |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_Vcpu Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_Vcpu |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_Vcpu |
Fields
| Name | Type | Description |
|---|---|---|
| id | UINT64 | List of VCPUs ids to allocate on this NUMA node |
vnfr:paired-threads
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/paired-threads |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.NumaNodePolicy.Node.PairedThreads |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__NumaNodePolicy__Node__PairedThreads |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:paired-thread-ids
List of thread pairs to use in case of paired-thread NUMA
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0 |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.GuestEpa.NumaNodePolicy.Node.PairedThreads.PairedThreadIds |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__GuestEpa__NumaNodePolicy__Node__PairedThreads__PairedThreadIds |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
Fields
| Name | Type | Description |
|---|---|---|
| thread-a | UINT8 | |
| thread-b | UINT8 |
vnfr:vswitch-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vswitch-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vswitch-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vswitch-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vswitch-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vswitch-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.VswitchEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_VswitchEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__VswitchEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_VswitchEpa Vnfr_data_VnfrCatalog_Vnfr_Vdur_VswitchEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:hypervisor-epa
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:hypervisor-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:hypervisor-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/hypervisor-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:hypervisor-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:hypervisor-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.HypervisorEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_HypervisorEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__HypervisorEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HypervisorEpa Vnfr_data_VnfrCatalog_Vnfr_Vdur_HypervisorEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HypervisorEpa |
Fields
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies the type of hypervisor. KVM: KVM XEN: XEN |
| version | STRING |
vnfr:host-epa
Specifies the host level EPA attributes.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.HostEpa |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_HostEpa |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__HostEpa |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:cpu-feature
List of CPU features.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:cpu-feature |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/cpu-feature/PREFER_AES |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:cpu-feature |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.HostEpa.CpuFeature |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_HostEpa_CpuFeature |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__HostEpa__CpuFeature |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_CpuFeature Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_CpuFeature |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_CpuFeature |
Fields
| Name | Type | Description |
|---|---|---|
| feature | ENUM | CPU feature. |
vnfr:om-cpu-feature
List of OpenMANO CPU features
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:om-cpu-feature |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/om-cpu-feature/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:om-cpu-feature |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.HostEpa.OmCpuFeature |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_HostEpa_OmCpuFeature |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__HostEpa__OmCpuFeature |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_OmCpuFeature Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_OmCpuFeature |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_HostEpa_OmCpuFeature |
Fields
| Name | Type | Description |
|---|---|---|
| feature | STRING | CPU feature |
vnfr:supplemental-boot-data
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/supplemental-boot-data |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.SupplementalBootData |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_SupplementalBootData |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__SupplementalBootData |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_SupplementalBootData Vnfr_data_VnfrCatalog_Vnfr_Vdur_SupplementalBootData |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
vnfr:config-file
List of configuration files to be written on an additional drive
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data/vnfr:config-file |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/supplemental-boot-data/config-file/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data/vnfr:config-file |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.SupplementalBootData.ConfigFile |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_SupplementalBootData_ConfigFile |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__SupplementalBootData__ConfigFile |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_SupplementalBootData_ConfigFile Vnfr_data_VnfrCatalog_Vnfr_Vdur_SupplementalBootData_ConfigFile |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_SupplementalBootData_ConfigFile |
Fields
| Name | Type | Description |
|---|---|---|
| source | STRING | Name of the configuration file |
| dest | STRING | Full path of the destination in the guest |
vnfr:volumes
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:volumes |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/volumes/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:volumes |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Volumes |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Volumes |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Volumes |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Volumes Vnfr_data_VnfrCatalog_Vnfr_Vdur_Volumes |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Volumes |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the disk-volumes, e.g. vda, vdb etc |
| volume-id | STRING | VIM assigned volume id |
| 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 |
vnfr:alarms
A list of the alarms that have been created for this VDU
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Alarms |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Alarms |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Alarms |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms |
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. |
vnfr:actions
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Alarms.Actions |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Alarms_Actions |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Alarms__Actions |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions |
Fields
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
vnfr:ok
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:ok |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/ok/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:ok |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Alarms.Actions.Ok |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Ok |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Alarms__Actions__Ok |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Ok Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Ok |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Ok |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:insufficient-data
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:insufficient-data |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/insufficient-data/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:insufficient-data |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Alarms.Actions.InsufficientData |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_InsufficientData |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Alarms__Actions__InsufficientData |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_InsufficientData Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_InsufficientData |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_InsufficientData |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:alarm
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:alarm |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/alarm/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:alarm |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.Alarms.Actions.Alarm |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Alarm |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__Alarms__Actions__Alarm |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Alarm Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Alarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_Alarms_Actions_Alarm |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr: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 components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-connection-point |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-connection-point/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-connection-point |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.InternalConnectionPoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_InternalConnectionPoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__InternalConnectionPoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalConnectionPoint Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalConnectionPoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_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 |
| ip-address | UNION | IP address assigned to the internal connection point |
| mac-address | STRING | MAC address assigned to the internal connection point |
vnfr:internal-interface
List of internal interfaces for the VNF
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-interface/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.InternalInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_InternalInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__InternalInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of internal interface. Note that this name has only local significance to the VDU. |
| vdur-internal-connection-point-ref | LEAFREF | |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
vnfr:virtual-interface
Container for the virtual interface properties
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface/vnfr:virtual-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-interface/STRING/virtual-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface/vnfr:virtual-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.InternalInterface.VirtualInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_InternalInterface_VirtualInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__InternalInterface__VirtualInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface_VirtualInterface Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_InternalInterface_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. |
| bandwidth | UINT64 | Aggregate bandwidth of the NIC. |
| ovs-offload | ENUM | Defines if the NIC supports OVS offload. MANDATORY : OVS offload support in the NIC is mandatory. PREFERRED : OVS offload support in the NIC is preferred. |
| vendor-id | STRING | Specifies the vendor specific id for the device. This is used when a NIC from specific HW vendor is required. |
| datapath-library | STRING | Specifies the name and version of the datapath library the NIC is expected to support. |
| provider-network-name | STRING | Name of the provider network to which this NIC is attached. |
vnfr:external-interface
List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/external-interface/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.ExternalInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_ExternalInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__ExternalInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the external interface. Note that this name has only local significance. |
| vnfd-connection-point-ref | LEAFREF | Name of the external connection point. |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
vnfr:virtual-interface
Container for the virtual interface properties
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface/vnfr:virtual-interface |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/external-interface/STRING/virtual-interface |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface/vnfr:virtual-interface |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.ExternalInterface.VirtualInterface |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_ExternalInterface_VirtualInterface |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__ExternalInterface__VirtualInterface |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface_VirtualInterface Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_ExternalInterface_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. |
| bandwidth | UINT64 | Aggregate bandwidth of the NIC. |
| ovs-offload | ENUM | Defines if the NIC supports OVS offload. MANDATORY : OVS offload support in the NIC is mandatory. PREFERRED : OVS offload support in the NIC is preferred. |
| vendor-id | STRING | Specifies the vendor specific id for the device. This is used when a NIC from specific HW vendor is required. |
| datapath-library | STRING | Specifies the name and version of the datapath library the NIC is expected to support. |
| provider-network-name | STRING | Name of the provider network to which this NIC is attached. |
vnfr:placement-groups-info
Placement groups to which this VDU belongs and its cloud construct
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.PlacementGroupsInfo |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__PlacementGroupsInfo |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo |
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. |
| cloud-type | ENUM | |
| availability-zone | CONTAINER | Name of the Availability Zone |
| server-group | CONTAINER | Name of the Affinity/Anti-Affinity Server Group |
| host-aggregate | LIST | Name of the Host Aggregate |
| aws-construct | EMPTY | |
| openmano-construct | EMPTY | |
| vsphere-construct | EMPTY | |
| mock-construct | EMPTY | |
| cloudsim-construct | EMPTY |
vnfr:availability-zone
Name of the Availability Zone
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:availability-zone |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/availability-zone |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:availability-zone |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.PlacementGroupsInfo.AvailabilityZone |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_AvailabilityZone |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__PlacementGroupsInfo__AvailabilityZone |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_AvailabilityZone Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_AvailabilityZone |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_AvailabilityZone |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING |
vnfr:server-group
Name of the Affinity/Anti-Affinity Server Group
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:server-group |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/server-group |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:server-group |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.PlacementGroupsInfo.ServerGroup |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_ServerGroup |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__PlacementGroupsInfo__ServerGroup |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_ServerGroup Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_ServerGroup |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_ServerGroup |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING |
vnfr:host-aggregate
Name of the Host Aggregate
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:host-aggregate |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/host-aggregate/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:host-aggregate |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.Vdur.PlacementGroupsInfo.HostAggregate |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_HostAggregate |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__Vdur__PlacementGroupsInfo__HostAggregate |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_HostAggregate Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_HostAggregate |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_Vdur_PlacementGroupsInfo_HostAggregate |
Fields
| Name | Type | Description |
|---|---|---|
| metadata-key | STRING | Name of the additional information attached to the host-aggregate |
| metadata-value | STRING | Value of the corresponding metadata-key |
vnfr:http-endpoint
List of http endpoints to be used by monitoring params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/http-endpoint/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.HttpEndpoint |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_HttpEndpoint |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__HttpEndpoint |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_HttpEndpoint Vnfr_data_VnfrCatalog_Vnfr_HttpEndpoint |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:headers
Custom HTTP headers to put on HTTP request
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint/vnfr:headers |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/http-endpoint/STRING/headers/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint/vnfr:headers |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.HttpEndpoint.Headers |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_HttpEndpoint_Headers |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__HttpEndpoint__Headers |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_HttpEndpoint_Headers Vnfr_data_VnfrCatalog_Vnfr_HttpEndpoint_Headers |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_HttpEndpoint_Headers |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | HTTP header key |
| value | STRING | HTTP header value |
vnfr:monitoring-param
List of monitoring parameters at the network service level
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/monitoring-param/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.MonitoringParam |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_MonitoringParam |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__MonitoringParam |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:json-query-params
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:json-query-params |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/monitoring-param/STRING/json-query-params |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:json-query-params |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.MonitoringParam.JsonQueryParams |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_MonitoringParam_JsonQueryParams |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__MonitoringParam__JsonQueryParams |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_JsonQueryParams Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_JsonQueryParams |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_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 |
vnfr:numeric-constraints
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:numeric-constraints |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/monitoring-param/STRING/numeric-constraints |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:numeric-constraints |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.MonitoringParam.NumericConstraints |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_MonitoringParam_NumericConstraints |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__MonitoringParam__NumericConstraints |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_NumericConstraints Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_NumericConstraints |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_NumericConstraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
vnfr:text-constraints
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:text-constraints |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/monitoring-param/STRING/text-constraints |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:text-constraints |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.MonitoringParam.TextConstraints |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_MonitoringParam_TextConstraints |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__MonitoringParam__TextConstraints |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_TextConstraints Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_TextConstraints |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_MonitoringParam_TextConstraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum string length for the parameter |
vnfr:placement-groups-info
Placement groups to which this VDU belongs and its cloud construct
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.PlacementGroupsInfo |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__PlacementGroupsInfo |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo |
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. |
| cloud-type | ENUM | |
| availability-zone | CONTAINER | Name of the Availability Zone |
| server-group | CONTAINER | Name of the Affinity/Anti-Affinity Server Group |
| host-aggregate | LIST | Name of the Host Aggregate |
| aws-construct | EMPTY | |
| openmano-construct | EMPTY | |
| vsphere-construct | EMPTY | |
| mock-construct | EMPTY | |
| cloudsim-construct | EMPTY |
vnfr:availability-zone
Name of the Availability Zone
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:availability-zone |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/availability-zone |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:availability-zone |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.PlacementGroupsInfo.AvailabilityZone |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo_AvailabilityZone |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__PlacementGroupsInfo__AvailabilityZone |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_AvailabilityZone Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_AvailabilityZone |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_AvailabilityZone |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING |
vnfr:server-group
Name of the Affinity/Anti-Affinity Server Group
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:server-group |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/server-group |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:server-group |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.PlacementGroupsInfo.ServerGroup |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo_ServerGroup |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__PlacementGroupsInfo__ServerGroup |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_ServerGroup Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_ServerGroup |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_ServerGroup |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING |
vnfr:host-aggregate
Name of the Host Aggregate
Key Identifiers:| XPath Path | /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:host-aggregate |
| XPath Keyed Path | /vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING'] |
| RW.REST URI Path | /vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/host-aggregate/STRING |
| RW Keyspec XPath Path | D,/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:host-aggregate |
| RW Keyspec XPath Keyed Path | D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING'] |
| Protobuf Type | .vnfr.YangData.Vnfr.VnfrCatalog.Vnfr.PlacementGroupsInfo.HostAggregate |
| Python Proto-GI Type | VnfrYang.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo_HostAggregate |
| C Protobuf-C Struct Type | Vnfr__YangData__Vnfr__VnfrCatalog__Vnfr__PlacementGroupsInfo__HostAggregate |
| C RWPB Identifiers | Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_HostAggregate Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_HostAggregate |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_data_VnfrCatalog_Vnfr_PlacementGroupsInfo_HostAggregate |
Fields
| Name | Type | Description |
|---|---|---|
| metadata-key | STRING | Name of the additional information attached to the host-aggregate |
| metadata-value | STRING | Value of the corresponding metadata-key |
vnfr rpc input
vnfr:create-alarm
Key Identifiers:| XPath Path | /vnfr:create-alarm |
| XPath Keyed Path | /vnfr:create-alarm |
| RW.REST URI Path | /input |
| RW Keyspec XPath Path | I,/vnfr:create-alarm |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm Vnfr_input_CreateAlarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm |
Fields
| Name | Type | Description |
|---|---|---|
| cloud-account | STRING | |
| vdur-id | STRING | |
| alarm | CONTAINER |
vnfr:alarm
Key Identifiers:| XPath Path | /vnfr:create-alarm/vnfr:alarm |
| XPath Keyed Path | /vnfr:create-alarm/vnfr:alarm |
| RW.REST URI Path | /input/alarm |
| RW Keyspec XPath Path | I,/vnfr:create-alarm/vnfr:alarm |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm/vnfr:alarm |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm.Alarm |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm_Alarm |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm__Alarm |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm_Alarm Vnfr_input_CreateAlarm_Alarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm_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. |
vnfr:actions
Key Identifiers:| XPath Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions |
| XPath Keyed Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions |
| RW.REST URI Path | /input/alarm/actions |
| RW Keyspec XPath Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm.Alarm.Actions |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm_Alarm_Actions |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm__Alarm__Actions |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions Vnfr_input_CreateAlarm_Alarm_Actions |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions |
Fields
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
vnfr:ok
Key Identifiers:| XPath Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok |
| XPath Keyed Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| RW.REST URI Path | /input/alarm/actions/ok/STRING |
| RW Keyspec XPath Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm.Alarm.Actions.Ok |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm_Alarm_Actions_Ok |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm__Alarm__Actions__Ok |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_Ok Vnfr_input_CreateAlarm_Alarm_Actions_Ok |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_Ok |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:insufficient-data
Key Identifiers:| XPath Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data |
| XPath Keyed Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| RW.REST URI Path | /input/alarm/actions/insufficient-data/STRING |
| RW Keyspec XPath Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm.Alarm.Actions.InsufficientData |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm_Alarm_Actions_InsufficientData |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm__Alarm__Actions__InsufficientData |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_InsufficientData Vnfr_input_CreateAlarm_Alarm_Actions_InsufficientData |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_InsufficientData |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:alarm
Key Identifiers:| XPath Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm |
| XPath Keyed Path | /vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| RW.REST URI Path | /input/alarm/actions/alarm/STRING |
| RW Keyspec XPath Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm |
| RW Keyspec XPath Keyed Path | I,/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm[vnfr:url='STRING'] |
| Protobuf Type | .vnfr.YangInput.Vnfr.CreateAlarm.Alarm.Actions.Alarm |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_CreateAlarm_Alarm_Actions_Alarm |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__CreateAlarm__Alarm__Actions__Alarm |
| C RWPB Identifiers | Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_Alarm Vnfr_input_CreateAlarm_Alarm_Actions_Alarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_CreateAlarm_Alarm_Actions_Alarm |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
vnfr:destroy-alarm
Key Identifiers:| XPath Path | /vnfr:destroy-alarm |
| XPath Keyed Path | /vnfr:destroy-alarm |
| RW.REST URI Path | /input |
| RW Keyspec XPath Path | I,/vnfr:destroy-alarm |
| RW Keyspec XPath Keyed Path | I,/vnfr:destroy-alarm |
| Protobuf Type | .vnfr.YangInput.Vnfr.DestroyAlarm |
| Python Proto-GI Type | VnfrYang.YangInput_Vnfr_DestroyAlarm |
| C Protobuf-C Struct Type | Vnfr__YangInput__Vnfr__DestroyAlarm |
| C RWPB Identifiers | Vnfr_Vnfr_input_DestroyAlarm Vnfr_input_DestroyAlarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_input_DestroyAlarm |
Fields
| Name | Type | Description |
|---|---|---|
| cloud-account | STRING | |
| alarm-id | STRING |
vnfr rpc output
vnfr:create-alarm
Key Identifiers:| XPath Path | /vnfr:create-alarm |
| XPath Keyed Path | /vnfr:create-alarm |
| RW.REST URI Path | /output |
| RW Keyspec XPath Path | O,/vnfr:create-alarm |
| RW Keyspec XPath Keyed Path | O,/vnfr:create-alarm |
| Protobuf Type | .vnfr.YangOutput.Vnfr.CreateAlarm |
| Python Proto-GI Type | VnfrYang.YangOutput_Vnfr_CreateAlarm |
| C Protobuf-C Struct Type | Vnfr__YangOutput__Vnfr__CreateAlarm |
| C RWPB Identifiers | Vnfr_Vnfr_output_CreateAlarm Vnfr_output_CreateAlarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_output_CreateAlarm |
Fields
| Name | Type | Description |
|---|---|---|
| alarm-id | STRING |
vnfr:destroy-alarm
Key Identifiers:| XPath Path | /vnfr:destroy-alarm |
| XPath Keyed Path | /vnfr:destroy-alarm |
| RW.REST URI Path | /output |
| RW Keyspec XPath Path | O,/vnfr:destroy-alarm |
| RW Keyspec XPath Keyed Path | O,/vnfr:destroy-alarm |
| Protobuf Type | .vnfr.YangOutput.Vnfr.DestroyAlarm |
| Python Proto-GI Type | VnfrYang.YangOutput_Vnfr_DestroyAlarm |
| C Protobuf-C Struct Type | Vnfr__YangOutput__Vnfr__DestroyAlarm |
| C RWPB Identifiers | Vnfr_Vnfr_output_DestroyAlarm Vnfr_output_DestroyAlarm |
| YPBC Base Identifier | rw_ypbc_Vnfr_Vnfr_output_DestroyAlarm |