rw-project - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_RwProjectNsd_RwProject_t_schema |
| Global Schema Pointer |
rw_ypbc_RwProjectNsd_RwProject_g_schema |
rw-project data
This yang module defines project-based tenancy for RIFT.ware.
Authorization for project access is defined in terms of RIFT.ware's
Role-Based Access Control (RBAC) model.
rw-project:project
Configuration and state for individual projects. RIFT.ware
applications and projects are expected to augment this list in
order to add configuration for projects that is specific to the
product or application. As such, this list contains minimal
data defined in this yang module.
When augmenting this element, other yang modules should prefer to
define containers with the same name as the augmenting module.
(Augmenting RIFT.ware modules should prefer to augment without
the rw prefix [for new features], or should prefer to augment the
augmented container of an existing augment, to ease future
adoption and/or standardization.)
Key Identifiers:
| XPath Path | /rw-project:project |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING |
| RW Keyspec XPath Path | C,/rw-project:project |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING'] |
| RW Keyspec XPath Path | D,/rw-project:project |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the project. |
| description | STRING | Information about project |
| project-config | CONTAINER | General Project configuration supported by all products. |
| project-state | CONTAINER | General Project operational state supported by all products. |
| vnfd-catalog | CONTAINER | Virtual Network Function Descriptor (VNFD). |
| nsd-catalog | CONTAINER | |
| vld-catalog | CONTAINER | |
rw-project:project-config
General Project configuration supported by all products.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-config |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config |
| RW.REST URI Path | /rw-project:project/STRING/project-config |
| RW Keyspec XPath Path | C,/rw-project:project/rw-project:project-config |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectConfig |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectConfig |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectConfig |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectConfig |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig |
Fields
| Name | Type | Description |
|---|
| user | LIST | The list of Users who have been assigned Roles within this
Project. |
rw-project:user
The list of Users who have been assigned Roles within this
Project.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-config/rw-project:user |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-config/user/STRING,STRING |
| RW Keyspec XPath Path | C,/rw-project:project/rw-project:project-config/rw-project:user |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectConfig.User |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectConfig_User |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectConfig__User |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectConfig_User |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig_User |
Fields
| Name | Type | Description |
|---|
| user-domain | LEAFREF | The user domain. This is the source of the user identity.
Different domains may duplicate a user-name, but such users
would be considered distinct by RIFT.ware. |
| user-name | LEAFREF | The user name. The syntax of this name depends on the domain.
For example, if the domain is a login name, it might be limited
to alphanumeric characters. However, if the domain is email address,
the syntax could include additional characters, such as the at(@) sign. |
| role | LIST | The list of Roles the User has been assigned. |
rw-project:role
The list of Roles the User has been assigned.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-config/rw-project:user/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-config/user/STRING,STRING/role/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/rw-project:project-config/rw-project:user/rw-project:role |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectConfig.User.Role |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectConfig_User_Role |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectConfig__User__Role |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectConfig_User_Role |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig_User_Role |
Fields
| Name | Type | Description |
|---|
| role | STRING | The Role, independent of Keys. |
rw-project:project-state
General Project operational state supported by all products.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-state |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state |
| RW.REST URI Path | /rw-project:project/STRING/project-state |
| RW Keyspec XPath Path | D,/rw-project:project/rw-project:project-state |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectState |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectState |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectState |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectState |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectState |
Fields
| Name | Type | Description |
|---|
| user | LIST | The state of Users who have been assigned Roles within
this Project. |
| role | LIST | The set of Roles that may be configured into
/rw-project:project/rw-project:config/rw-project:user/
rw-project:role. |
rw-project:user
The state of Users who have been assigned Roles within
this Project.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-state/rw-project:user |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/user/STRING,STRING |
| RW Keyspec XPath Path | D,/rw-project:project/rw-project:project-state/rw-project:user |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectState.User |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectState_User |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectState__User |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectState_User |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectState_User |
Fields
| Name | Type | Description |
|---|
| user-domain | STRING | The user domain. This is the source of the user identity.
Different domains may duplicate a user-name, but such users
would be considered distinct by RIFT.ware. |
| user-name | STRING | The user name. The syntax of this name depends on the domain.
For example, if the domain is a login name, it might be limited
to alphanumeric characters. However, if the domain is some
kind of email address, the syntax could include assitional
characters, such as the at sign. |
| role | LIST | The state of the Roles the User has been assigned. |
rw-project:role
The state of the Roles the User has been assigned.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-state/rw-project:user/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/user/STRING,STRING/role/STRING |
| RW Keyspec XPath Path | D,/rw-project:project/rw-project:project-state/rw-project:user/rw-project:role |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectState.User.Role |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectState_User_Role |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectState__User__Role |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectState_User_Role |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectState_User_Role |
Fields
| Name | Type | Description |
|---|
| role | STRING | The Role, independent of Keys. |
| state | STRING | The assignment of a User to a Role may be an asynchronous
operation. This value indicates whether the Role
assignment is active. If the value is 'active', then the
assignment is complete and active. Any other value
indicates that Role assignment is in a transitional or
failed state, as described in the value. |
rw-project:role
The set of Roles that may be configured into
/rw-project:project/rw-project:config/rw-project:user/
rw-project:role.
Key Identifiers:
| XPath Path | /rw-project:project/rw-project:project-state/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/role/STRING |
| RW Keyspec XPath Path | D,/rw-project:project/rw-project:project-state/rw-project:role |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING'] |
| Protobuf Type | .rw_project.YangData.RwProject.Project.ProjectState.Role |
| Python Proto-GI Type | RwProjectYang.YangData_RwProject_Project_ProjectState_Role |
| C Protobuf-C Struct Type | RwProject__YangData__RwProject__Project__ProjectState__Role |
| C RWPB Identifiers | RwProject_RwProject_data_Project_ProjectState_Role |
| YPBC Base Identifier | rw_ypbc_RwProject_RwProject_data_Project_ProjectState_Role |
Fields
| Name | Type | Description |
|---|
| role | STRING | The Role, independent of Keys. |
| description | STRING | A description of the Role. |
project-vnfd:vnfd-catalog
Virtual Network Function Descriptor (VNFD).
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog |
Fields
| Name | Type | Description |
|---|
| vnfd | LIST | |
project-vnfd:vnfd
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VNFD. |
| name | STRING | VNFD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Vendor of the VNFD. |
| logo | STRING | Vendor logo for the Virtual Network Function |
| description | STRING | Description of the VNFD. |
| version | STRING | Version of the VNFD |
| vnf-configuration | CONTAINER | 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 |
| meta | STRING | Any meta-data needed by the UI |
| config-parameter | CONTAINER | List of VNF config parameter requests and sources |
project-vnfd:vnf-configuration
Information about the VNF configuration. Note:
If the NS contains multiple instances of the
same VNF, each instance could have a different
configuration.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration |
Fields
project-vnfd:script
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:script |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:script |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/script |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:script |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:script |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.Script |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_Script |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__Script |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_Script |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_Script |
Fields
| Name | Type | Description |
|---|
| script-type | ENUM | Script type - currently supported - Scripts confirming to Rift CA plugin |
project-vnfd:juju
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:juju |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:juju |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:juju |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:juju |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.Juju |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_Juju |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__Juju |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_Juju |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_Juju |
Fields
| Name | Type | Description |
|---|
| charm | STRING | Juju charm to use with the VNF. |
project-vnfd:config-primitive
List of config primitives supported by the
configuration agent for this VNF.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.ConfigPrimitive |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__ConfigPrimitive |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the config primitive. |
| parameter | LIST | List of parameters to the config primitive. |
| user-defined-script | STRING | A user defined script. If user defined script is defined,
the script will be executed using bash |
project-vnfd:parameter
List of parameters to the config primitive.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive/project-vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.ConfigPrimitive.Parameter |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__ConfigPrimitive__Parameter |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_ConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI.
Only applies to parameters with default values. |
| hidden | BOOLEAN | The value should be hidden by the UI.
Only applies to parameters with default values. |
| out | BOOLEAN | If this is an output of the primitive execution |
project-vnfd:initial-config-primitive
Initial set of configuration primitives.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.InitialConfigPrimitive |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__InitialConfigPrimitive |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive |
Fields
| Name | Type | Description |
|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| parameter | LIST | List of parameters to the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
| config-primitive-ref | LEAFREF | Reference to a config primitive name.
NOTE: The config primitive referred should have
all the input parameters predefined either
with default values or dependency references. |
project-vnfd:parameter
List of parameters to the configuration primitive.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive/project-vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VnfConfiguration.InitialConfigPrimitive.Parameter |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VnfConfiguration__InitialConfigPrimitive__Parameter |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VnfConfiguration_InitialConfigPrimitive_Parameter |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the parameter. |
| value | STRING | Value associated with the name. |
project-vnfd:mgmt-interface
Interface over which the VNF is managed.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MgmtInterface |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MgmtInterface |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MgmtInterface |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MgmtInterface |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MgmtInterface |
Fields
| Name | Type | Description |
|---|
| ip-address | UNION | |
| vdu-id | LEAFREF | |
| cp | LEAFREF | |
| port | UINT16 | Port for the management interface. |
| dashboard-params | CONTAINER | Parameters for the VNF dashboard |
| ssh-key | BOOLEAN | Whether SSH keys need to be generated and passed
to the RO and VCA during instantiation. |
project-vnfd:dashboard-params
Parameters for the VNF dashboard
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface/dashboard-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MgmtInterface.DashboardParams |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MgmtInterface__DashboardParams |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MgmtInterface_DashboardParams |
Fields
| Name | Type | Description |
|---|
| path | STRING | The HTTP path for the dashboard |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The HTTP port for the dashboard |
project-vnfd:internal-vld
List of Internal Virtual Link Descriptors (VLD).
The internal VLD describes the basic topology of
the connectivity such as E-LAN, E-Line, E-Tree.
between internal VNF components of the system.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.InternalVld |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_InternalVld |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__InternalVld |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VLD |
| name | STRING | Name of the internal VLD |
| short-name | STRING | Short name to appear as label in the UI |
| description | STRING | |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| internal-connection-point | LIST | List of internal connection points in this VLD |
| provider-network | CONTAINER | Container for the provider network. |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate
pre-provisioned network name in cloud account. |
| ip-profile-ref | STRING | Named reference to IP-profile object |
| virtual-connection-points | LIST | A list of virtual-connection points associated with Virtual Link.
These connection points are not directly associated with any VDUs |
project-vnfd:internal-connection-point
List of internal connection points in this VLD
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:internal-connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/internal-connection-point/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:internal-connection-point |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id-ref='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.InternalVld.InternalConnectionPoint |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__InternalVld__InternalConnectionPoint |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_InternalConnectionPoint |
Fields
| Name | Type | Description |
|---|
| id-ref | LEAFREF | reference to the internal connection point id |
project-vnfd:provider-network
Container for the provider network.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:provider-network |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:provider-network |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/provider-network |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:provider-network |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:provider-network |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.InternalVld.ProviderNetwork |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__InternalVld__ProviderNetwork |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_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
PORTGROUP - Provider networks implemented for VIO support |
| segmentation_id | UINT32 | ID of segregated virtual networks |
rw-project-vnfd:virtual-connection-points
A list of virtual-connection points associated with Virtual Link.
These connection points are not directly associated with any VDUs
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/rw-project-vnfd:virtual-connection-points |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/rw-project-vnfd:virtual-connection-points[rw-project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/rw-project-vnfd:virtual-connection-points/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/rw-project-vnfd:virtual-connection-points |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/rw-project-vnfd:virtual-connection-points[rw-project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.InternalVld.VirtualConnectionPoints |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__InternalVld__VirtualConnectionPoints |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints |
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 |
| associated-cps | LEAF_LIST | A List of connection points associated with virtual connection point |
rw-project-vnfd:associated-cps
A List of connection points associated with virtual connection point
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/rw-project-vnfd:virtual-connection-points/rw-project-vnfd:associated-cps |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/rw-project-vnfd:virtual-connection-points[rw-project-vnfd:name='STRING']/rw-project-vnfd:associated-cps |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/rw-project-vnfd:virtual-connection-points/STRING/associated-cps |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/rw-project-vnfd:virtual-connection-points/rw-project-vnfd:associated-cps |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/rw-project-vnfd:virtual-connection-points[rw-project-vnfd:name='STRING']/rw-project-vnfd:associated-cps |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.InternalVld.VirtualConnectionPoints.AssociatedCps |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints_AssociatedCps |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__InternalVld__VirtualConnectionPoints__AssociatedCps |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints_AssociatedCps |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_InternalVld_VirtualConnectionPoints_AssociatedCps |
project-vnfd:ip-profiles
List of IP Profiles.
IP Profile describes the IP characteristics for the Virtual-Link
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.IpProfiles |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_IpProfiles |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__IpProfiles |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER | |
project-vnfd:ip-profile-params
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams |
Fields
| Name | Type | Description |
|---|
| ip-version | ENUM | |
| subnet-address | UNION | Subnet IP prefix associated with IP Profile |
| gateway-address | UNION | IP Address of the default gateway associated with IP Profile |
| security-group | STRING | Name of the security group |
| dns-server | LIST | |
| dhcp-params | CONTAINER | |
| subnet-prefix-pool | STRING | VIM Specific reference to pre-created subnet prefix |
project-vnfd:dns-server
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dns-server |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dns-server[project-vnfd:address='UNION_VALUE'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dns-server |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dns-server[project-vnfd:address='UNION_VALUE'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams.DnsServer |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams__DnsServer |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|
| address | UNION | List of DNS Servers associated with IP Profile |
project-vnfd:dhcp-params
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.IpProfiles.IpProfileParams.DhcpParams |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__IpProfiles__IpProfileParams__DhcpParams |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_IpProfiles_IpProfileParams_DhcpParams |
Fields
| Name | Type | Description |
|---|
| enabled | BOOLEAN | This flag indicates if DHCP is enabled or not |
| start-address | UNION | Start IP address of the IP-Address range associated with DHCP domain |
| count | UINT32 | Size of the DHCP pool associated with DHCP domain |
project-vnfd:connection-point
List for external connection points. Each VNF has one
or more external connection points that connect the VNF
to other VNFs or to external networks. Each VNF exposes
connection points to the orchestrator, which can construct
network services by connecting the connection points
between different VNFs. The NFVO will use VLDs and VNFFGs
at the network service level to construct network services.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:connection-point[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/connection-point/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:connection-point |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:connection-point[project-vnfd:name='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConnectionPoint |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConnectionPoint |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConnectionPoint |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConnectionPoint |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConnectionPoint |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
project-vnfd:vdu
List of Virtual Deployment Units
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu |
Fields
| Name | Type | Description |
|---|
| id | STRING | Unique id for the VDU |
| name | STRING | Unique name for the VDU |
| description | STRING | Description of the VDU. |
| count | UINT64 | Number of instances of VDU |
| mgmt-vpci | STRING | Specifies the virtual PCI address. Expressed in
the following format dddd:dd:dd.d. For example
0000:00:12.0. This information can be used to
pass as metadata during the VM creation. |
| vm-flavor | CONTAINER | |
| guest-epa | CONTAINER | |
| vswitch-epa | CONTAINER | |
| hypervisor-epa | CONTAINER | |
| host-epa | CONTAINER | Specifies the host level EPA attributes. |
| 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. |
| interface | LIST | List of Interfaces (external and internal) for the VNF |
| volumes | LIST | |
project-vnfd:vm-flavor
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vm-flavor |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vm-flavor |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vm-flavor |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vm-flavor |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vm-flavor |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.VmFlavor |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_VmFlavor |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__VmFlavor |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_VmFlavor |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_VmFlavor |
Fields
| Name | Type | Description |
|---|
| vcpu-count | UINT16 | Number of VCPUs for the VM. |
| memory-mb | UINT64 | Amount of memory in MB. |
| storage-gb | UINT64 | Amount of disk space in GB. |
| vm-flavor-name | STRING | flavor name to be used while creating vm using cloud account |
project-vnfd:guest-epa
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa |
Fields
| Name | Type | Description |
|---|
| trusted-execution | BOOLEAN | This VM should be allocated from trusted pool |
| mempage-size | ENUM | Memory page allocation size. If a VM requires
hugepages, it should choose LARGE or SIZE_2MB
or SIZE_1GB. If the VM prefers hugepages it
should choose PREFER_LARGE.
LARGE : Require hugepages (either 2MB or 1GB)
SMALL : Doesn't require hugepages
SIZE_2MB : Requires 2MB hugepages
SIZE_1GB : Requires 1GB hugepages
PREFER_LARGE : Application prefers hugepages |
| cpu-pinning-policy | ENUM | CPU pinning policy describes association
between virtual CPUs in guest and the
physical CPUs in the host.
DEDICATED : Virtual CPUs are pinned to
physical CPUs
SHARED : Multiple VMs may share the
same physical CPUs.
ANY : Any policy is acceptable for the VM |
| cpu-thread-pinning-policy | ENUM | CPU thread pinning policy describes how to
place the guest CPUs when the host supports
hyper threads:
AVOID : Avoids placing a guest on a host
with threads.
SEPARATE: Places vCPUs on separate cores,
and avoids placing two vCPUs on
two threads of same core.
ISOLATE : Places each vCPU on a different core,
and places no vCPUs from a different
guest on the same core.
PREFER : Attempts to place vCPUs on threads
of the same core. |
| pcie-device | LIST | List of pcie passthrough devices. |
| numa-unaware | EMPTY | |
| numa-node-policy | CONTAINER | This policy defines NUMA topology of the
guest. Specifically identifies if the guest
should be run on a host with one NUMA
node or multiple NUMA nodes. As an example
a guest might need 8 VCPUs and 4 GB of
memory. However, it might need the VCPUs
and memory distributed across multiple
NUMA nodes. In this scenario, NUMA node
1 could run with 6 VCPUs and 3GB, and
NUMA node 2 could run with 2 VCPUs and
1GB. |
project-vnfd:pcie-device
List of pcie passthrough devices.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:pcie-device |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:pcie-device[project-vnfd:device-id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/pcie-device/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:pcie-device |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:pcie-device[project-vnfd:device-id='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.PcieDevice |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__PcieDevice |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_PcieDevice |
Fields
| Name | Type | Description |
|---|
| device-id | STRING | Device identifier. |
| count | UINT64 | Number of devices to attach to the VM. |
project-vnfd:numa-node-policy
This policy defines NUMA topology of the
guest. Specifically identifies if the guest
should be run on a host with one NUMA
node or multiple NUMA nodes. As an example
a guest might need 8 VCPUs and 4 GB of
memory. However, it might need the VCPUs
and memory distributed across multiple
NUMA nodes. In this scenario, NUMA node
1 could run with 6 VCPUs and 3GB, and
NUMA node 2 could run with 2 VCPUs and
1GB.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy |
Fields
| Name | Type | Description |
|---|
| node-cnt | UINT16 | The number of NUMA nodes to expose to the VM. |
| mem-policy | ENUM | This policy specifies how the memory should
be allocated in a multi-node scenario.
STRICT : The memory must be allocated
strictly from the memory attached
to the NUMA node.
PREFERRED : The memory should be allocated
preferentially from the memory
attached to the NUMA node |
| node | LIST | |
project-vnfd:node
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node |
Fields
| Name | Type | Description |
|---|
| id | UINT64 | NUMA node identification. Typically
it's 0 or 1 |
| vcpu | LIST | List of VCPUs to allocate on
this NUMA node. |
| memory-mb | UINT64 | Memory size expressed in MB
for this NUMA node. |
| num-cores | UINT8 | |
| paired-threads | CONTAINER | |
| num-threads | UINT8 | |
project-vnfd:vcpu
List of VCPUs to allocate on
this NUMA node.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:vcpu |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:vcpu[project-vnfd:id='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/vcpu/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:vcpu |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:vcpu[project-vnfd:id='0'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.Vcpu |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__Vcpu |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_Vcpu |
Fields
| Name | Type | Description |
|---|
| id | UINT64 | List of VCPUs ids to allocate on
this NUMA node |
project-vnfd:paired-threads
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads |
Fields
| Name | Type | Description |
|---|
| num-paired-threads | UINT8 | |
| paired-thread-ids | LIST | List of thread pairs to use in case of paired-thread NUMA |
project-vnfd:paired-thread-ids
List of thread pairs to use in case of paired-thread NUMA
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads/project-vnfd:paired-thread-ids |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads/project-vnfd:paired-thread-ids[project-vnfd:thread-a='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads/project-vnfd:paired-thread-ids |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads/project-vnfd:paired-thread-ids[project-vnfd:thread-a='0'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.GuestEpa.NumaNodePolicy.Node.PairedThreads.PairedThreadIds |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__GuestEpa__NumaNodePolicy__Node__PairedThreads__PairedThreadIds |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_GuestEpa_NumaNodePolicy_Node_PairedThreads_PairedThreadIds |
Fields
| Name | Type | Description |
|---|
| thread-a | UINT8 | |
| thread-b | UINT8 | |
project-vnfd:vswitch-epa
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vswitch-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vswitch-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vswitch-epa |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vswitch-epa |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vswitch-epa |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.VswitchEpa |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_VswitchEpa |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__VswitchEpa |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_VswitchEpa |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_VswitchEpa |
Fields
| Name | Type | Description |
|---|
| ovs-acceleration | ENUM | Specifies Open vSwitch acceleration mode.
MANDATORY: OVS acceleration is required
PREFERRED: OVS acceleration is preferred |
| ovs-offload | ENUM | Specifies Open vSwitch hardware offload mode.
MANDATORY: OVS offload is required
PREFERRED: OVS offload is preferred |
project-vnfd:hypervisor-epa
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:hypervisor-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:hypervisor-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/hypervisor-epa |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:hypervisor-epa |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:hypervisor-epa |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.HypervisorEpa |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_HypervisorEpa |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__HypervisorEpa |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HypervisorEpa |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HypervisorEpa |
Fields
| Name | Type | Description |
|---|
| type | ENUM | Specifies the type of hypervisor.
KVM: KVM
XEN: XEN |
| version | STRING | |
project-vnfd:host-epa
Specifies the host level EPA attributes.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.HostEpa |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_HostEpa |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__HostEpa |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa |
Fields
| Name | Type | Description |
|---|
| cpu-model | ENUM | Host CPU model. Examples include: SandyBridge,
IvyBridge |
| cpu-arch | ENUM | Host CPU architecture. |
| cpu-vendor | ENUM | Host CPU Vendor. |
| cpu-socket-count | UINT64 | Number of sockets on the host. |
| cpu-core-count | UINT64 | Number of cores on the host. |
| cpu-core-thread-count | UINT64 | Number of threads per cores on the host. |
| cpu-feature | LIST | List of CPU features. |
| om-cpu-model-string | STRING | OpenMANO CPU model string |
| om-cpu-feature | LIST | List of OpenMANO CPU features |
project-vnfd:cpu-feature
List of CPU features.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:cpu-feature |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:cpu-feature[project-vnfd:feature='PREFER_AES'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/cpu-feature/PREFER_AES |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:cpu-feature |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:cpu-feature[project-vnfd:feature='PREFER_AES'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.HostEpa.CpuFeature |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__HostEpa__CpuFeature |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_CpuFeature |
Fields
| Name | Type | Description |
|---|
| feature | ENUM | CPU feature. |
project-vnfd:om-cpu-feature
List of OpenMANO CPU features
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:om-cpu-feature |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:om-cpu-feature[project-vnfd:feature='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/om-cpu-feature/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:om-cpu-feature |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:om-cpu-feature[project-vnfd:feature='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.HostEpa.OmCpuFeature |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__HostEpa__OmCpuFeature |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_HostEpa_OmCpuFeature |
Fields
| Name | Type | Description |
|---|
| feature | STRING | CPU feature |
project-vnfd:supplemental-boot-data
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.SupplementalBootData |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__SupplementalBootData |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData |
Fields
| Name | Type | Description |
|---|
| config-file | LIST | List of configuration files to be written on an additional drive |
| boot-data-drive | BOOLEAN | Some VIMs implement additional drives to host config-files or meta-data |
| custom-meta-data | LIST | List of meta-data to be associated with the instance |
project-vnfd:config-file
List of configuration files to be written on an additional drive
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data/project-vnfd:config-file |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data/project-vnfd:config-file[project-vnfd:source='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data/config-file/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data/project-vnfd:config-file |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data/project-vnfd:config-file[project-vnfd:source='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.SupplementalBootData.ConfigFile |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__SupplementalBootData__ConfigFile |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_SupplementalBootData_ConfigFile |
Fields
| Name | Type | Description |
|---|
| source | STRING | Name of the configuration file |
| dest | STRING | Full path of the destination in the guest |
project-vnfd:internal-connection-point
List for internal connection points. Each VNFC
has zero or more internal connection points.
Internal connection points are used for connecting
the VNF with components internal to the VNF. If a VNF
has only one VNFC, it may not have any internal
connection points.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:internal-connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/internal-connection-point/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:internal-connection-point |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.InternalConnectionPoint |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__InternalConnectionPoint |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_InternalConnectionPoint |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
| internal-vld-ref | LEAFREF | |
project-vnfd:interface
List of Interfaces (external and internal) for the VNF
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.Interface |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_Interface |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__Interface |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Interface |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Interface |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the interface. Note that this
name has only local significance to the VDU. |
| position | UINT32 | Explicit Position of the interface within the list |
| type | ENUM | Type of the Interface |
| internal-connection-point-ref | LEAFREF | Leaf Ref to the particular internal connection point |
| external-connection-point-ref | LEAFREF | Leaf Ref to the particular external connection point |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
| static-ip-address | UNION | Static IP address for the connection point |
| floating-ip-needed | BOOLEAN | Sole purpose of this field is to facilitate translation of VNFD
to other VNFMs |
project-vnfd:virtual-interface
Container for the virtual interface properties
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface/project-vnfd:virtual-interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING']/project-vnfd:virtual-interface |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING/virtual-interface |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface/project-vnfd:virtual-interface |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING']/project-vnfd:virtual-interface |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.Interface.VirtualInterface |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__Interface__VirtualInterface |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Interface_VirtualInterface |
Fields
| Name | Type | Description |
|---|
| type | ENUM | Specifies the type of virtual interface
between VM and host.
VIRTIO : Use the traditional VIRTIO interface.
PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface.
SR-IOV : Use SR-IOV interface.
E1000 : Emulate E1000 interface.
RTL8139 : Emulate RTL8139 interface.
PCNET : Emulate PCNET interface.
OM-MGMT : Used to specify openmano mgmt external-connection type |
| vpci | STRING | Specifies the virtual PCI address. Expressed in
the following format dddd:dd:dd.d. For example
0000:00:12.0. This information can be used to
pass as metadata during the VM creation. |
| bandwidth | UINT64 | Aggregate bandwidth of the NIC. |
project-vnfd:volumes
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:volumes |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:volumes[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/volumes/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:volumes |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:volumes[project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.Vdu.Volumes |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_Vdu_Volumes |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__Vdu__Volumes |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Volumes |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_Vdu_Volumes |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the disk-volumes, e.g. vda, vdb etc |
| description | STRING | Description for Volume |
| size | UINT64 | Size of disk in GB |
| ephemeral | EMPTY | |
| image | STRING | Image name for the software image.
If the image name is found within the VNF package it will
be uploaded to all VIM accounts during onboarding process.
Otherwise, the image must be added to the VIM account with
the same name as entered here.
|
| image-checksum | STRING | Image md5sum for the software image.
The md5sum, if provided, along with the image name uniquely
identifies an image uploaded to the CAL.
|
| volume-ref | STRING | Reference for pre-existing volume in VIM |
| 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 |
| boot-volume | BOOLEAN | This flag indicates if this is boot volume or not |
| boot-priority | INT32 | Boot priority associated with volume |
| custom-meta-data | LIST | List of meta-data to be associated with the instance |
project-vnfd:vdu-dependency
List of VDU dependencies.
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu-dependency |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu-dependency[project-vnfd:vdu-source-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu-dependency/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu-dependency |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu-dependency[project-vnfd:vdu-source-ref='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.VduDependency |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_VduDependency |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__VduDependency |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VduDependency |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_VduDependency |
Fields
| Name | Type | Description |
|---|
| vdu-source-ref | LEAFREF | |
| vdu-depends-on-ref | LEAFREF | Reference to the VDU on which
the source VDU depends. |
project-vnfd:http-endpoint
List of http endpoints to be used by monitoring params
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:http-endpoint |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:http-endpoint[project-vnfd:path='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/http-endpoint/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:http-endpoint |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:http-endpoint[project-vnfd:path='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.HttpEndpoint |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_HttpEndpoint |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__HttpEndpoint |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_HttpEndpoint |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_HttpEndpoint |
Fields
| Name | Type | Description |
|---|
| path | STRING | The HTTP path on the management server |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The HTTP port to connect to |
| username | STRING | The HTTP basic auth username |
| password | STRING | The HTTP basic auth password |
| polling-interval-secs | UINT8 | The HTTP polling interval in seconds |
| method | ENUM | Method that the URI should perform.
Deafult action is GET. |
| headers | LIST | Custom HTTP headers to put on HTTP request |
| data | STRING | This is the data to be sent with POST |
project-vnfd:monitoring-param
List of monitoring parameters at the network service level
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MonitoringParam |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MonitoringParam |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MonitoringParam |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam |
Fields
| Name | Type | Description |
|---|
| id | STRING | |
| name | STRING | |
| http-endpoint-ref | LEAFREF | |
| json-query-method | ENUM | |
| json-query-params | CONTAINER | |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameters |
| widget-type | ENUM | Defines the UI Display variant of measured counters. |
| units | STRING | Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.) |
| value-type | ENUM | |
| numeric-constraints | CONTAINER | |
| text-constraints | CONTAINER | |
| value-integer | INT64 | Current value for an integer parameter |
| value-decimal | DECIMAL64 | Current value for a decimal parameter |
| value-string | STRING | Current value for a string parameter |
project-vnfd:json-query-params
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:json-query-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:json-query-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/json-query-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:json-query-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:json-query-params |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MonitoringParam.JsonQueryParams |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MonitoringParam__JsonQueryParams |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_JsonQueryParams |
Fields
| Name | Type | Description |
|---|
| json-path | STRING | The jsonpath to use to extract value from JSON structure |
| object-path | STRING | The objectpath to use to extract value from JSON structure |
project-vnfd:numeric-constraints
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:numeric-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:numeric-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/numeric-constraints |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:numeric-constraints |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:numeric-constraints |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MonitoringParam.NumericConstraints |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MonitoringParam__NumericConstraints |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_NumericConstraints |
Fields
| Name | Type | Description |
|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
project-vnfd:text-constraints
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:text-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:text-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/text-constraints |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:text-constraints |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:text-constraints |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.MonitoringParam.TextConstraints |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__MonitoringParam__TextConstraints |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_MonitoringParam_TextConstraints |
Fields
| Name | Type | Description |
|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum string length for the parameter |
project-vnfd:placement-groups
List of placement groups at VNF level
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.PlacementGroups |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_PlacementGroups |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__PlacementGroups |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_PlacementGroups |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_PlacementGroups |
Fields
| Name | Type | Description |
|---|
| name | STRING | Place group construct to define the compute resource placement strategy
in cloud environment |
| requirement | STRING | This is free text space used to describe the intent/rationale
behind this placement group. This is for human consumption only |
| strategy | ENUM | Strategy associated with this placement group
Following values are possible
- COLOCATION: Colocation strategy imply intent to share the physical
infrastructure (hypervisor/network) among all members
of this group.
- ISOLATION: Isolation strategy imply intent to not share the physical
infrastructure (hypervisor/network) among the members
of this group.
|
| member-vdus | LIST | List of VDUs that are part of this placement group |
project-vnfd:member-vdus
List of VDUs that are part of this placement group
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups/project-vnfd:member-vdus |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING']/project-vnfd:member-vdus[project-vnfd:member-vdu-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING/member-vdus/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups/project-vnfd:member-vdus |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING']/project-vnfd:member-vdus[project-vnfd:member-vdu-ref='STRING'] |
| Protobuf Type | .project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.PlacementGroups.MemberVdus |
| Python Proto-GI Type | ProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus |
| C Protobuf-C Struct Type | ProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__PlacementGroups__MemberVdus |
| C RWPB Identifiers | ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus |
| YPBC Base Identifier | rw_ypbc_ProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_PlacementGroups_MemberVdus |
Fields
| Name | Type | Description |
|---|
| member-vdu-ref | LEAFREF | |
rw-project-vnfd:config-parameter
List of VNF config parameter requests and sources
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/rw-project-vnfd:config-parameter |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConfigParameter |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConfigParameter |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConfigParameter |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter |
Fields
rw-project-vnfd:config-parameter-source
The list of parameters exposed by this VNF
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source[rw-project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/rw-project-vnfd:config-parameter/config-parameter-source/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source[rw-project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConfigParameter.ConfigParameterSource |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConfigParameter__ConfigParameterSource |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the source |
| description | STRING | Description of the source |
| descriptor | STRING | Location of this source as an xpath.
For example:
../../../mgmt-interface/port |
| attribute | STRING | Location of this source as runtime attribute.
The value is ,
For example:
../../../mgmt-interface, ip-address
which retruns the ip-address assigned to the
mgmt-interface after VNF instantiation. |
| config-primitive-name-ref | LEAFREF | A leafref to configuration primitive.
This refers to a config parameter whose
output parameter is referred in out-parameter. |
| parameter-ref | LEAFREF | Name of the output parameter in the config primitiive |
| value | STRING | Pre-defined value to be used for this source |
| parameter | LIST | |
rw-project-vnfd:parameter
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source/rw-project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source[rw-project-vnfd:name='STRING']/rw-project-vnfd:parameter[rw-project-vnfd:config-primitive-name-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/rw-project-vnfd:config-parameter/config-parameter-source/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source/rw-project-vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-source[rw-project-vnfd:name='STRING']/rw-project-vnfd:parameter[rw-project-vnfd:config-primitive-name-ref='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConfigParameter.ConfigParameterSource.Parameter |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource_Parameter |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConfigParameter__ConfigParameterSource__Parameter |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource_Parameter |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterSource_Parameter |
Fields
| Name | Type | Description |
|---|
| config-primitive-name-ref | LEAFREF | Name of the configuration primitive where this
request will used |
| config-primitive-parameter-ref | LEAFREF | Parameter name of the config primitive |
rw-project-vnfd:config-parameter-request
The list of requests for this VNF
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request[rw-project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/rw-project-vnfd:config-parameter/config-parameter-request/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request[rw-project-vnfd:name='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConfigParameter.ConfigParameterRequest |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConfigParameter__ConfigParameterRequest |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of this parameter request |
| description | STRING | Description of this request |
| parameter | LIST | |
rw-project-vnfd:parameter
Key Identifiers:
| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request/rw-project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request[rw-project-vnfd:name='STRING']/rw-project-vnfd:parameter[rw-project-vnfd:config-primitive-name-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/rw-project-vnfd:config-parameter/config-parameter-request/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request/rw-project-vnfd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/rw-project-vnfd:config-parameter/rw-project-vnfd:config-parameter-request[rw-project-vnfd:name='STRING']/rw-project-vnfd:parameter[rw-project-vnfd:config-primitive-name-ref='STRING'] |
| Protobuf Type | .rw_project_vnfd.YangData.RwProject.Project.VnfdCatalog.Vnfd.ConfigParameter.ConfigParameterRequest.Parameter |
| Python Proto-GI Type | RwProjectVnfdYang.YangData_RwProject_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest_Parameter |
| C Protobuf-C Struct Type | RwProjectVnfd__YangData__RwProject__Project__VnfdCatalog__Vnfd__ConfigParameter__ConfigParameterRequest__Parameter |
| C RWPB Identifiers | RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest_Parameter |
| YPBC Base Identifier | rw_ypbc_RwProjectVnfd_RwProject_data_Project_VnfdCatalog_Vnfd_ConfigParameter_ConfigParameterRequest_Parameter |
Fields
| Name | Type | Description |
|---|
| config-primitive-name-ref | LEAFREF | Name of the configuration primitive where this
request will used |
| config-primitive-parameter-ref | LEAFREF | Parameter name of the config primitive |
project-nsd:nsd-catalog
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog |
Fields
| Name | Type | Description |
|---|
| nsd | LIST | |
project-nsd:nsd
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the NSD. |
| name | STRING | NSD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Vendor of the NSD. |
| logo | STRING | File path for the vendor specific logo. For example icons/mylogo.png.
The logo should be part of the network service |
| description | STRING | Description of the NSD. |
| version | STRING | Version of the NSD |
| connection-point | LIST | List for external connection points.
Each NS has one or more external connection
points. As the name implies that external
connection points are used for connecting
the NS to other NS or to external networks.
Each NS exposes these connection points to
the orchestrator. The orchestrator can
construct network service chains by
connecting the connection points between
different NS. |
| scaling-group-descriptor | LIST | scaling group descriptor within this network service.
The scaling group defines a group of VNFs,
and the ratio of VNFs in the network service
that is used as target for scaling action |
| vnffgd | LIST | List of VNF Forwarding Graph Descriptors (VNFFGD). |
| ip-profiles | LIST | List of IP Profiles.
IP Profile describes the IP characteristics for the Virtual-Link |
| initial-service-primitive | LIST | Initial set of service primitives for NSD. |
| terminate-service-primitive | LIST | Set of service primitives during
termination for NSD. |
| input-parameter-xpath | LIST | List of xpaths to parameters inside the NSD
the can be customized during the instantiation. |
| parameter-pool | LIST | Pool of parameter values which must be
pulled from during configuration |
| key-pair | LIST | Used to configure the list of public keys to be injected as part
of ns instantiation |
| user | LIST | List of users to be added through cloud-config |
| vld | LIST | |
| constituent-vnfd | LIST | List of VNFDs that are part of this
network service. |
| placement-groups | LIST | List of placement groups at NS level |
| vnf-dependency | LIST | List of VNF dependencies. |
| monitoring-param | LIST | |
| service-primitive | LIST | Network service level service primitives. |
| control-param | LIST | List of control parameters to manage and
update the running configuration of the VNF |
| action-param | LIST | List of action parameters to
control VNF |
| meta | STRING | Any meta-data needed by the UI |
| config-parameter-map | LIST | A mapping of VNF config parameter
requests and sources within this network service |
project-nsd:connection-point
List for external connection points.
Each NS has one or more external connection
points. As the name implies that external
connection points are used for connecting
the NS to other NS or to external networks.
Each NS exposes these connection points to
the orchestrator. The orchestrator can
construct network service chains by
connecting the connection points between
different NS.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:connection-point[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/connection-point/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:connection-point |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:connection-point[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ConnectionPoint |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ConnectionPoint |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ConnectionPoint |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConnectionPoint |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConnectionPoint |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the NS connection point. |
| type | ENUM | Type of the connection point. |
project-nsd:scaling-group-descriptor
scaling group descriptor within this network service.
The scaling group defines a group of VNFs,
and the ratio of VNFs in the network service
that is used as target for scaling action
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ScalingGroupDescriptor |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ScalingGroupDescriptor |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ScalingGroupDescriptor |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of this scaling group. |
| scaling-policy | LIST | |
| vnfd-member | LIST | List of VNFs in this scaling group |
| min-instance-count | UINT32 | Minimum instances of the scaling group which are allowed.
These instances are created by default when the network service
is instantiated. |
| max-instance-count | UINT32 | Maximum instances of this scaling group that are allowed
in a single network service. The network service scaling
will fail, when the number of service group instances
exceed the max-instance-count specified. |
| scaling-config-action | LIST | List of scaling config actions |
project-nsd:scaling-policy
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingPolicy |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingPolicy |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the scaling policy |
| scaling-type | ENUM | Type of scaling |
| enabled | BOOLEAN | Specifies if the scaling policy can be applied |
| scale-in-operation-type | ENUM | Operation to be applied to check between scaling criterias to
check if the scale in threshold condition has been met.
Defaults to AND |
| scale-out-operation-type | ENUM | Operation to be applied to check between scaling criterias to
check if the scale out threshold condition has been met.
Defauls to OR |
| threshold-time | UINT32 | The duration for which the criteria must hold true |
| cooldown-time | UINT32 | The duration after a scaling-in/scaling-out action has been
triggered, for which there will be no further optional |
| scaling-criteria | LIST | list of conditions to be met for generating scaling
requests |
project-nsd:scaling-criteria
list of conditions to be met for generating scaling
requests
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy/project-nsd:scaling-criteria |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING']/project-nsd:scaling-criteria[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy/project-nsd:scaling-criteria |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING']/project-nsd:scaling-criteria[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingPolicy.ScalingCriteria |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingPolicy__ScalingCriteria |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingPolicy_ScalingCriteria |
Fields
| Name | Type | Description |
|---|
| name | STRING | |
| scale-in-threshold | UINT64 | Value below which scale-in requests are generated |
| scale-out-threshold | UINT64 | Value above which scale-out requests are generated |
| ns-monitoring-param-ref | LEAFREF | Reference to the NS level monitoring parameter
that is aggregated |
project-nsd:vnfd-member
List of VNFs in this scaling group
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:vnfd-member |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:vnfd-member[project-nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/vnfd-member/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:vnfd-member |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:vnfd-member[project-nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ScalingGroupDescriptor.VnfdMember |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ScalingGroupDescriptor__VnfdMember |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_VnfdMember |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | member VNF index of this member VNF |
| count | UINT32 | count of this member VNF within this scaling group.
The count allows to define the number of instances
when a scaling action targets this scaling group |
project-nsd:scaling-config-action
List of scaling config actions
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-config-action |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-config-action[project-nsd:trigger='pre-scale-in'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-config-action |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-config-action[project-nsd:trigger='pre-scale-in'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ScalingGroupDescriptor.ScalingConfigAction |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ScalingGroupDescriptor__ScalingConfigAction |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ScalingGroupDescriptor_ScalingConfigAction |
Fields
| Name | Type | Description |
|---|
| trigger | ENUM | scaling trigger |
| ns-service-primitive-name-ref | LEAFREF | Reference to the NS service primitive |
project-nsd:vnffgd
List of VNF Forwarding Graph Descriptors (VNFFGD).
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vnffgd |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vnffgd |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vnffgd |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VNFFGD. |
| name | STRING | VNFFGD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VNFFGD. |
| description | STRING | Description of the VNFFGD. |
| version | STRING | Version of the VNFFGD |
| rsp | LIST | List of Rendered Service Paths (RSP). |
| classifier | LIST | List of classifier rules. |
project-nsd:rsp
List of Rendered Service Paths (RSP).
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vnffgd.Rsp |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vnffgd_Rsp |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vnffgd__Rsp |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Rsp |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Rsp |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the RSP. |
| name | STRING | RSP name. |
| vnfd-connection-point-ref | LIST | A list of references to connection points. |
project-nsd:vnfd-connection-point-ref
A list of references to connection points.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp/project-nsd:vnfd-connection-point-ref |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING/vnfd-connection-point-ref/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp/project-nsd:vnfd-connection-point-ref |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vnffgd.Rsp.VnfdConnectionPointRef |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vnffgd__Rsp__VnfdConnectionPointRef |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Rsp_VnfdConnectionPointRef |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| order | UINT8 | A number that denotes the order of a VNF in a chain |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../../../nsd:constituent-vnfd
+ [nsd:id = current()/../nsd:id-ref]
+ /nsd:vnfd-id-ref |
| vnfd-connection-point-ref | STRING | A reference to a connection point name
in a vnfd. This is a leafref to path:
/vnfd:vnfd-catalog/vnfd:vnfd
+ [vnfd:id = current()/../nsd:vnfd-id-ref]
+ /vnfd:connection-point/vnfd:name
NOTE: An issue with confd is preventing the
use of xpath. Seems to be an issue with leafref
to leafref, whose target is in a different module.
Once that is resolved this will switched to use
leafref |
project-nsd:classifier
List of classifier rules.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vnffgd.Classifier |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vnffgd_Classifier |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vnffgd__Classifier |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Classifier |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Classifier |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the classifier rule. |
| name | STRING | Name of the classifier. |
| rsp-id-ref | LEAFREF | A reference to the RSP. |
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../../nsd:constituent-vnfd
+ [nsd:id = current()/../nsd:id-ref]
+ /nsd:vnfd-id-ref |
| vnfd-connection-point-ref | STRING | A reference to a connection point name
in a vnfd. This is a leafref to path:
/vnfd:vnfd-catalog/vnfd:vnfd
+ [vnfd:id = current()/../nsd:vnfd-id-ref]
+ /vnfd:connection-point/vnfd:name
NOTE: An issue with confd is preventing the
use of xpath. Seems to be an issue with leafref
to leafref, whose target is in a different module.
Once that is resolved this will switched to use
leafref |
| match-attributes | LIST | List of match attributes. |
project-nsd:match-attributes
List of match attributes.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier/project-nsd:match-attributes |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING']/project-nsd:match-attributes[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING/match-attributes/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier/project-nsd:match-attributes |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING']/project-nsd:match-attributes[project-nsd:id='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vnffgd.Classifier.MatchAttributes |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vnffgd__Classifier__MatchAttributes |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vnffgd_Classifier_MatchAttributes |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the classifier match attribute rule. |
| ip-proto | UINT8 | IP Protocol. |
| source-ip-address | UNION | Source IP address. |
| destination-ip-address | UNION | Destination IP address. |
| source-port | UINT16 | Source port number. |
| destination-port | UINT16 | Destination port number. |
project-nsd:ip-profiles
List of IP Profiles.
IP Profile describes the IP characteristics for the Virtual-Link
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.IpProfiles |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_IpProfiles |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__IpProfiles |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER | |
project-nsd:ip-profile-params
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.IpProfiles.IpProfileParams |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__IpProfiles__IpProfileParams |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_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 |
project-nsd:dns-server
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dns-server |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dns-server[project-nsd:address='UNION_VALUE'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dns-server |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dns-server[project-nsd:address='UNION_VALUE'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.IpProfiles.IpProfileParams.DnsServer |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__IpProfiles__IpProfileParams__DnsServer |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|
| address | UNION | List of DNS Servers associated with IP Profile |
project-nsd:dhcp-params
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dhcp-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dhcp-params |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dhcp-params |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dhcp-params |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.IpProfiles.IpProfileParams.DhcpParams |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DhcpParams |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__IpProfiles__IpProfileParams__DhcpParams |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_IpProfiles_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_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 |
project-nsd:initial-service-primitive
Initial set of service primitives for NSD.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.InitialServicePrimitive |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_InitialServicePrimitive |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__InitialServicePrimitive |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_InitialServicePrimitive |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_InitialServicePrimitive |
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 | |
project-nsd:parameter
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive/project-nsd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive/project-nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.InitialServicePrimitive.Parameter |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__InitialServicePrimitive__Parameter |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_InitialServicePrimitive_Parameter |
Fields
| Name | Type | Description |
|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
project-nsd:terminate-service-primitive
Set of service primitives during
termination for NSD.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.TerminateServicePrimitive |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_TerminateServicePrimitive |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__TerminateServicePrimitive |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_TerminateServicePrimitive |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_TerminateServicePrimitive |
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 | |
project-nsd:parameter
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive/project-nsd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive/project-nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.TerminateServicePrimitive.Parameter |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__TerminateServicePrimitive__Parameter |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_TerminateServicePrimitive_Parameter |
Fields
| Name | Type | Description |
|---|
| name | STRING | |
| value | STRING | Value of the configuration primitive. |
project-nsd:parameter-pool
Pool of parameter values which must be
pulled from during configuration
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ParameterPool |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ParameterPool |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ParameterPool |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ParameterPool |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ParameterPool |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the configuration value pool |
| range | CONTAINER | Create a range of values to populate the pool with |
project-nsd:range
Create a range of values to populate the pool with
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool/project-nsd:range |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING']/project-nsd:range |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING/range |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool/project-nsd:range |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING']/project-nsd:range |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ParameterPool.Range |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ParameterPool_Range |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ParameterPool__Range |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ParameterPool_Range |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ParameterPool_Range |
Fields
| Name | Type | Description |
|---|
| start-value | UINT32 | Generated pool values start at this value |
| end-value | UINT32 | Generated pool values stop at this value |
project-nsd:key-pair
Used to configure the list of public keys to be injected as part
of ns instantiation
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:key-pair |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:key-pair[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/key-pair/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:key-pair |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:key-pair[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.KeyPair |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_KeyPair |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__KeyPair |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_KeyPair |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_KeyPair |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of this key pair |
| key | STRING | Key associated with this key pair |
project-nsd:user
List of users to be added through cloud-config
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/user/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.User |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_User |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__User |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_User |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_User |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the user |
| user-info | STRING | The user name's real name |
| key-pair | LIST | Used to configure the list of public keys to be injected as part
of ns instantiation |
project-nsd:key-pair
Used to configure the list of public keys to be injected as part
of ns instantiation
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user/project-nsd:key-pair |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING']/project-nsd:key-pair[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/user/STRING/key-pair/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user/project-nsd:key-pair |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING']/project-nsd:key-pair[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.User.KeyPair |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_User_KeyPair |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__User__KeyPair |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_User_KeyPair |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_User_KeyPair |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of this key pair |
| key | STRING | Key associated with this key pair |
project-nsd:vld
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vld |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vld |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vld |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VLD. |
| name | STRING | Virtual Link Descriptor (VLD) name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VLD. |
| description | STRING | Description of the VLD. |
| version | STRING | Version of the VLD |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| provider-network | CONTAINER | Container for the provider network. |
| mgmt-network | BOOLEAN | Flag indicating whether this network is a VIM management 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 |
| vnfd-connection-point-ref | LIST | A list of references to connection points. |
| ipv4-nat-pool-name | STRING | IPV4 nat pool name |
| virtual-connection-points | LIST | A list of virtual-connection points associated with Virtual Link.
These connection points are not directly associated with any VNFs |
project-nsd:provider-network
Container for the provider network.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:provider-network |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:provider-network |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING/provider-network |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:provider-network |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:provider-network |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vld.ProviderNetwork |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vld_ProviderNetwork |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vld__ProviderNetwork |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_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
PORTGROUP - Provider networks implemented for VIO support |
| segmentation_id | UINT32 | ID of segregated virtual networks |
project-nsd:vnfd-connection-point-ref
A list of references to connection points.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:vnfd-connection-point-ref |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-connection-point-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING/vnfd-connection-point-ref/0,STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:vnfd-connection-point-ref |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-connection-point-ref='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vld.VnfdConnectionPointRef |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vld__VnfdConnectionPointRef |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VnfdConnectionPointRef |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../constituent-vnfd
+ [id = current()/../id-ref]
+ /vnfd-id-ref
NOTE: An issue with confd is preventing the
use of xpath. Seems to be an issue with leafref
to leafref, whose target is in a different module.
Once that is resolved this will switched to use
leafref |
| vnfd-connection-point-ref | LEAFREF | A reference to a connection point name |
rw-project-nsd:virtual-connection-points
A list of virtual-connection points associated with Virtual Link.
These connection points are not directly associated with any VNFs
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/rw-project-nsd:virtual-connection-points |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/rw-project-nsd:virtual-connection-points[rw-project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING/rw-project-nsd:virtual-connection-points/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/rw-project-nsd:virtual-connection-points |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/rw-project-nsd:virtual-connection-points[rw-project-nsd:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vld.VirtualConnectionPoints |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vld__VirtualConnectionPoints |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints |
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 |
| associated-cps | LEAF_LIST | A List of connection points associated with virtual connection point |
rw-project-nsd:associated-cps
A List of connection points associated with virtual connection point
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/rw-project-nsd:virtual-connection-points/rw-project-nsd:associated-cps |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/rw-project-nsd:virtual-connection-points[rw-project-nsd:name='STRING']/rw-project-nsd:associated-cps |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING/rw-project-nsd:virtual-connection-points/STRING/associated-cps |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/rw-project-nsd:virtual-connection-points/rw-project-nsd:associated-cps |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/rw-project-nsd:virtual-connection-points[rw-project-nsd:name='STRING']/rw-project-nsd:associated-cps |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.Vld.VirtualConnectionPoints.AssociatedCps |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__Vld__VirtualConnectionPoints__AssociatedCps |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_Vld_VirtualConnectionPoints_AssociatedCps |
project-nsd:constituent-vnfd
List of VNFDs that are part of this
network service.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:constituent-vnfd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:constituent-vnfd[project-nsd:member-vnf-index='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/constituent-vnfd/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:constituent-vnfd |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:constituent-vnfd[project-nsd:member-vnf-index='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ConstituentVnfd |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ConstituentVnfd |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ConstituentVnfd |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConstituentVnfd |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConstituentVnfd |
Fields
| Name | Type | Description |
|---|
| member-vnf-index | UINT64 | Identifier/index for the VNFD. This separate id
is required to ensure that multiple VNFs can be
part of single NS |
| vnfd-id-ref | LEAFREF | Identifier for the VNFD. |
| start-by-default | BOOLEAN | VNFD is started as part of the NS instantiation |
project-nsd:placement-groups
List of placement groups at NS level
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/placement-groups/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.PlacementGroups |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_PlacementGroups |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__PlacementGroups |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_PlacementGroups |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_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-vnfd | LIST | List of VNFDs that are part of this placement group |
project-nsd:member-vnfd
List of VNFDs that are part of this placement group
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups/project-nsd:member-vnfd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING']/project-nsd:member-vnfd[project-nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/placement-groups/STRING/member-vnfd/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups/project-nsd:member-vnfd |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING']/project-nsd:member-vnfd[project-nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.PlacementGroups.MemberVnfd |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__PlacementGroups__MemberVnfd |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_PlacementGroups_MemberVnfd |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | member VNF index of this member VNF |
| vnfd-id-ref | LEAFREF | Identifier for the VNFD. |
project-nsd:vnf-dependency
List of VNF dependencies.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnf-dependency |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnf-dependency[project-nsd:vnf-source-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnf-dependency/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnf-dependency |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnf-dependency[project-nsd:vnf-source-ref='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.VnfDependency |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_VnfDependency |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__VnfDependency |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_VnfDependency |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_VnfDependency |
Fields
| Name | Type | Description |
|---|
| vnf-source-ref | LEAFREF | |
| vnf-depends-on-ref | LEAFREF | Reference to VNF that sorce VNF depends. |
project-nsd:monitoring-param
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.MonitoringParam |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_MonitoringParam |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__MonitoringParam |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam |
Fields
| Name | Type | Description |
|---|
| id | STRING | |
| name | STRING | |
| 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 |
| 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.) |
| aggregation-type | ENUM | |
| vnfd-monitoring-param | LIST | A list of VNFD monitoring params |
project-nsd:numeric-constraints
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:numeric-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:numeric-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/numeric-constraints |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:numeric-constraints |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:numeric-constraints |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.MonitoringParam.NumericConstraints |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__MonitoringParam__NumericConstraints |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_NumericConstraints |
Fields
| Name | Type | Description |
|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
project-nsd:text-constraints
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:text-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:text-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/text-constraints |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:text-constraints |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:text-constraints |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.MonitoringParam.TextConstraints |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__MonitoringParam__TextConstraints |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_TextConstraints |
Fields
| Name | Type | Description |
|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum string length for the parameter |
project-nsd:vnfd-monitoring-param
A list of VNFD monitoring params
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:vnfd-monitoring-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:vnfd-monitoring-param[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-monitoring-param-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/vnfd-monitoring-param/0,STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:vnfd-monitoring-param |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:vnfd-monitoring-param[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-monitoring-param-ref='STRING'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.MonitoringParam.VnfdMonitoringParam |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__MonitoringParam__VnfdMonitoringParam |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_MonitoringParam_VnfdMonitoringParam |
Fields
| Name | Type | Description |
|---|
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../../../nsd:constituent-vnfd
+ [nsd:id = current()/../nsd:id-ref]
+ /nsd:vnfd-id-ref
NOTE: An issue with confd is preventing the
use of xpath. Seems to be an issue with leafref
to leafref, whose target is in a different module.
Once that is resolved this will switched to use
leafref |
| vnfd-monitoring-param-ref | LEAFREF | A reference to the VNFD monitoring param |
| member-vnf-index-ref | LEAFREF | Optional reference to member-vnf within constituent-vnfds |
project-nsd:service-primitive
Network service level service primitives.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the service primitive. |
| parameter | LIST | List of parameters for the service primitive. |
| parameter-group | LIST | Grouping of parameters which are logically grouped in UI |
| vnf-primitive-group | LIST | List of service primitives grouped by VNF. |
| user-defined-script | STRING | A user defined script. |
project-nsd:parameter
List of parameters for the service primitive.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive.Parameter |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive_Parameter |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive__Parameter |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_Parameter |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_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. |
| out | BOOLEAN | If this is an output of the primitive execution |
project-nsd:parameter-group
Grouping of parameters which are logically grouped in UI
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive.ParameterGroup |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive__ParameterGroup |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup |
Fields
| Name | Type | Description |
|---|
| name | STRING | Name of the parameter group |
| parameter | LIST | List of parameters for the service primitive. |
| mandatory | BOOLEAN | Is this parameter group mandatory |
project-nsd:parameter
List of parameters for the service primitive.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group/project-nsd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING/parameter/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group/project-nsd:parameter |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive.ParameterGroup.Parameter |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_Parameter |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive__ParameterGroup__Parameter |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_Parameter |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_ParameterGroup_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. |
| out | BOOLEAN | If this is an output of the primitive execution |
project-nsd:vnf-primitive-group
List of service primitives grouped by VNF.
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive.VnfPrimitiveGroup |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive__VnfPrimitiveGroup |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a leafref |
| vnfd-name | LEAFREF | Name of the VNFD |
| primitive | LIST | |
project-nsd:primitive
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group/project-nsd:primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0']/project-nsd:primitive[project-nsd:index='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0/primitive/0 |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group/project-nsd:primitive |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0']/project-nsd:primitive[project-nsd:index='0'] |
| Protobuf Type | .project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ServicePrimitive.VnfPrimitiveGroup.Primitive |
| Python Proto-GI Type | ProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
| C Protobuf-C Struct Type | ProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ServicePrimitive__VnfPrimitiveGroup__Primitive |
| C RWPB Identifiers | ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
| YPBC Base Identifier | rw_ypbc_ProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ServicePrimitive_VnfPrimitiveGroup_Primitive |
Fields
| Name | Type | Description |
|---|
| index | UINT32 | Index of this primitive |
| name | STRING | Name of the primitive in the VNF primitive |
rw-project-nsd:control-param
List of control parameters to manage and
update the running configuration of the VNF
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:control-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:control-param[rw-project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/rw-project-nsd:control-param/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:control-param |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:control-param[rw-project-nsd:id='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ControlParam |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ControlParam |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ControlParam |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ControlParam |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ControlParam |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for control parameter |
| name | STRING | Name of a control parameter |
| description | STRING | A description of the control parameter |
| group-tag | STRING | A tag to group control parameters |
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
| current-value | UINT64 | Current value for the parameter |
| step-value | UINT64 | Step value for the parameter |
| units | STRING | |
| widget-type | ENUM | |
| url | STRING | This is the URL where the operation should be performed. |
| method | ENUM | Method that the URI should perform.
Default Action is POST |
| payload | STRING | This is the operation payload or payload template as stringified
JSON. This field provides the data to be sent for this operation
call |
rw-project-nsd:action-param
List of action parameters to
control VNF
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:action-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:action-param[rw-project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/rw-project-nsd:action-param/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:action-param |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:action-param[rw-project-nsd:id='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ActionParam |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ActionParam |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ActionParam |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ActionParam |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ActionParam |
Fields
| Name | Type | Description |
|---|
| id | STRING | |
| name | STRING | |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameter |
| url | STRING | This is the URL where to perform the operation |
| method | ENUM | This is the method to be performed at the uri.
POST by default for action |
| payload | STRING | This is the operation payload or payload template to be sent in
the data for this operation call |
rw-project-nsd:config-parameter-map
A mapping of VNF config parameter
requests and sources within this network service
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/rw-project-nsd:config-parameter-map/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING'] |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ConfigParameterMap |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ConfigParameterMap |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ConfigParameterMap |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap |
Fields
rw-project-nsd:config-parameter-request
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map/rw-project-nsd:config-parameter-request |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING']/rw-project-nsd:config-parameter-request |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/rw-project-nsd:config-parameter-map/STRING/config-parameter-request |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map/rw-project-nsd:config-parameter-request |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING']/rw-project-nsd:config-parameter-request |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ConfigParameterMap.ConfigParameterRequest |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ConfigParameterMap__ConfigParameterRequest |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterRequest |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../project-nsd:constituent-vnfd
+ [project-nsd:id = current()/../id-ref]
+ /project-nsd:vnfd-id-ref |
| config-parameter-request-ref | LEAFREF | Reference to the request in the VNF
with the specified member-vnf-index |
rw-project-nsd:config-parameter-source
Key Identifiers:
| XPath Path | /rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map/rw-project-nsd:config-parameter-source |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING']/rw-project-nsd:config-parameter-source |
| RW.REST URI Path | /rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/rw-project-nsd:config-parameter-map/STRING/config-parameter-source |
| RW Keyspec XPath Path | C,/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/rw-project-nsd:config-parameter-map/rw-project-nsd:config-parameter-source |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/rw-project-nsd:config-parameter-map[rw-project-nsd:id='STRING']/rw-project-nsd:config-parameter-source |
| Protobuf Type | .rw_project_nsd.YangData.RwProject.Project.NsdCatalog.Nsd.ConfigParameterMap.ConfigParameterSource |
| Python Proto-GI Type | RwProjectNsdYang.YangData_RwProject_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
| C Protobuf-C Struct Type | RwProjectNsd__YangData__RwProject__Project__NsdCatalog__Nsd__ConfigParameterMap__ConfigParameterSource |
| C RWPB Identifiers | RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
| YPBC Base Identifier | rw_ypbc_RwProjectNsd_RwProject_data_Project_NsdCatalog_Nsd_ConfigParameterMap_ConfigParameterSource |
Fields
| Name | Type | Description |
|---|
| member-vnf-index-ref | LEAFREF | Reference to member-vnf within constituent-vnfds |
| vnfd-id-ref | LEAFREF | A reference to a vnfd. This is a
leafref to path:
../../project-nsd:constituent-vnfd
+ [project-nsd:id = current()/../id-ref]
+ /project-nsd:vnfd-id-ref |
| config-parameter-source-ref | LEAFREF | Reference to the source in the VNF
with the specified member-vnf-index |
vld:vld-catalog
Key Identifiers:
| XPath Path | /rw-project:project/vld:vld-catalog |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vld:vld-catalog |
| RW.REST URI Path | /rw-project:project/STRING/vld:vld-catalog |
| RW Keyspec XPath Path | C,/rw-project:project/vld:vld-catalog |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/vld:vld-catalog |
| Protobuf Type | .vld.YangData.RwProject.Project.VldCatalog |
| Python Proto-GI Type | VldYang.YangData_RwProject_Project_VldCatalog |
| C Protobuf-C Struct Type | Vld__YangData__RwProject__Project__VldCatalog |
| C RWPB Identifiers | Vld_RwProject_data_Project_VldCatalog |
| YPBC Base Identifier | rw_ypbc_Vld_RwProject_data_Project_VldCatalog |
Fields
| Name | Type | Description |
|---|
| vld | LIST | |
vld:vld
Key Identifiers:
| XPath Path | /rw-project:project/vld:vld-catalog/vld:vld |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/vld:vld-catalog/vld/STRING |
| RW Keyspec XPath Path | C,/rw-project:project/vld:vld-catalog/vld:vld |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING'] |
| Protobuf Type | .vld.YangData.RwProject.Project.VldCatalog.Vld |
| Python Proto-GI Type | VldYang.YangData_RwProject_Project_VldCatalog_Vld |
| C Protobuf-C Struct Type | Vld__YangData__RwProject__Project__VldCatalog__Vld |
| C RWPB Identifiers | Vld_RwProject_data_Project_VldCatalog_Vld |
| YPBC Base Identifier | rw_ypbc_Vld_RwProject_data_Project_VldCatalog_Vld |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VLD. |
| name | STRING | Virtual Link Descriptor (VLD) name. |
| short-name | STRING | Short name for VLD for UI |
| vendor | STRING | Provider of the VLD. |
| description | STRING | Description of the VLD. |
| version | STRING | Version of the VLD |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| vnfd-connection-point-ref | LIST | A list of references to connection points. |
| provider-network | CONTAINER | Container for the provider network. |
vld:vnfd-connection-point-ref
A list of references to connection points.
Key Identifiers:
| XPath Path | /rw-project:project/vld:vld-catalog/vld:vld/vld:vnfd-connection-point-ref |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:vnfd-connection-point-ref[vld:vnfd-ref='STRING'][vld:member-vnf-index-ref='0'] |
| RW.REST URI Path | /rw-project:project/STRING/vld:vld-catalog/vld/STRING/vnfd-connection-point-ref/STRING,0 |
| RW Keyspec XPath Path | C,/rw-project:project/vld:vld-catalog/vld:vld/vld:vnfd-connection-point-ref |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:vnfd-connection-point-ref[vld:vnfd-ref='STRING'][vld:member-vnf-index-ref='0'] |
| Protobuf Type | .vld.YangData.RwProject.Project.VldCatalog.Vld.VnfdConnectionPointRef |
| Python Proto-GI Type | VldYang.YangData_RwProject_Project_VldCatalog_Vld_VnfdConnectionPointRef |
| C Protobuf-C Struct Type | Vld__YangData__RwProject__Project__VldCatalog__Vld__VnfdConnectionPointRef |
| C RWPB Identifiers | Vld_RwProject_data_Project_VldCatalog_Vld_VnfdConnectionPointRef |
| YPBC Base Identifier | rw_ypbc_Vld_RwProject_data_Project_VldCatalog_Vld_VnfdConnectionPointRef |
Fields
| Name | Type | Description |
|---|
| vnfd-ref | LEAFREF | A reference to a vnfd |
| member-vnf-index-ref | UINT64 | A reference to the consituent-vnfd id in nsd.
Should have been a leafref to:
'/rw-project:project/project-nsd:nsd-catalog:/nsd/constituent-vnfd/member-vnf-index-ref'.
Instead using direct leaf to avoid circular reference. |
| vnfd-connection-point-ref | LEAFREF | A reference to a connection point name in a vnfd |
vld:provider-network
Container for the provider network.
Key Identifiers:
| XPath Path | /rw-project:project/vld:vld-catalog/vld:vld/vld:provider-network |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:provider-network |
| RW.REST URI Path | /rw-project:project/STRING/vld:vld-catalog/vld/STRING/provider-network |
| RW Keyspec XPath Path | C,/rw-project:project/vld:vld-catalog/vld:vld/vld:provider-network |
| RW Keyspec XPath Keyed Path | C,/rw-project:project[rw-project:name='STRING']/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:provider-network |
| Protobuf Type | .vld.YangData.RwProject.Project.VldCatalog.Vld.ProviderNetwork |
| Python Proto-GI Type | VldYang.YangData_RwProject_Project_VldCatalog_Vld_ProviderNetwork |
| C Protobuf-C Struct Type | Vld__YangData__RwProject__Project__VldCatalog__Vld__ProviderNetwork |
| C RWPB Identifiers | Vld_RwProject_data_Project_VldCatalog_Vld_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_Vld_RwProject_data_Project_VldCatalog_Vld_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
PORTGROUP - Provider networks implemented for VIO support |
| segmentation_id | UINT32 | ID of segregated virtual networks |
project-nsd - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_RwProjectNsd_ProjectNsd_t_schema |
| Global Schema Pointer |
rw_ypbc_RwProjectNsd_ProjectNsd_g_schema |
rw-project-nsd - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_RwProjectNsd_RwProjectNsd_t_schema |
| Global Schema Pointer |
rw_ypbc_RwProjectNsd_RwProjectNsd_g_schema |