rw-project - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_Vlr_RwProject_t_schema |
| Global Schema Pointer |
rw_ypbc_Vlr_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 | .vlr.YangData.RwProject.Project |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project |
| C RWPB Identifiers | Vlr_RwProject_data_Project |
| YPBC Base Identifier | rw_ypbc_Vlr_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. |
| vlr-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. |
vlr:vlr-catalog
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog |
Fields
| Name | Type | Description |
|---|
| schema-version | STRING | Schema version for the VLR. If unspecified, it assumes v3.0 |
| vlr | LIST | |
vlr:vlr
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog/vlr:vlr |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog/vlr:vlr |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING'] |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog.Vlr |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog__Vlr |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog_Vlr |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr |
Fields
| Name | Type | Description |
|---|
| id | STRING | Identifier for the VLR. |
| name | STRING | VLR name. |
| nsr-id-ref | STRING | NS instance identifier.
This is a leafref /rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:id |
| vld-ref | STRING | Reference to VLD
/rw-project:project/nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref]
/nsd/vld:vld/vld:id |
| res-id | STRING | Identifier for resmgr id mapping |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VLR. |
| description | STRING | Description of the VLR. |
| version | STRING | Version of the VLR |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| create-time | UINT32 | Creation timestamp of this Virtual Link.
The timestamp is expressed as seconds
since unix epoch - 1970-01-01T00:00:00Z |
| uptime | UINT32 | Active period of this Virtual Link.
Uptime is expressed in seconds |
| network-id | STRING | Identifier for the allocated network resource. |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate
pre-provisioned network name in cloud account. |
| provider-network | CONTAINER | Container for the provider network. |
| ip-profile-params | CONTAINER | |
| status | ENUM | Status of the virtual link record. |
| operational-status | ENUM | The operational status of the Virtual Link
init : The VL is in init stat.
vl-alloc-pending : The VL alloc is pending in VIM
running : The VL is up and running in VM
vl-terminate-pending : The VL is being terminated in VIM.
terminated : The VL is terminated in the VM.
failed : The VL instantiation failed in VIM.
|
vlr:provider-network
Container for the provider network.
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:provider-network |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/provider-network |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:provider-network |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.ProviderNetwork |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_ProviderNetwork |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__ProviderNetwork |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog_Vlr_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_ProviderNetwork |
Fields
| Name | Type | Description |
|---|
| physical-network | STRING | Name of the physical network on which the provider
network is built. |
| segmentation_id | UINT32 | ID of segregated virtual networks |
vlr:ip-profile-params
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_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 |
vlr:dns-server
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE'] |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dns-server/UNION_VALUE |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE'] |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams.DnsServer |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams__DnsServer |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|
| address | UNION | List of DNS Servers associated with IP Profile |
vlr:dhcp-params
Key Identifiers:
| XPath Path | /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params |
| RW.REST URI Path | /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dhcp-params |
| RW Keyspec XPath Path | D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params |
| RW Keyspec XPath Keyed Path | D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params |
| Protobuf Type | .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams.DhcpParams |
| Python Proto-GI Type | VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams_DhcpParams |
| C Protobuf-C Struct Type | Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams__DhcpParams |
| C RWPB Identifiers | Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_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 |
vlr - Programmers API Reference
Schema Globals
| Global Schema Type |
rw_ypbc_Vlr_Vlr_t_schema |
| Global Schema Pointer |
rw_ypbc_Vlr_Vlr_g_schema |