rw-project - User documentation

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

Fields
NameTypeDescription
nameSTRINGName of the project.
descriptionSTRINGInformation about project
project-configCONTAINERGeneral Project configuration supported by all products.
project-stateCONTAINERGeneral Project operational state supported by all products.
vlr-catalogCONTAINER

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

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

Fields
NameTypeDescription
userLISTThe list of Users who have been assigned Roles within this Project.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

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

Fields
NameTypeDescription
user-domainLEAFREFThe 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-nameLEAFREFThe 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.
roleLISTThe list of Roles the User has been assigned.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

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

Fields
NameTypeDescription
roleSTRINGThe Role, independent of Keys.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample

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

Fields
NameTypeDescription
userLISTThe state of Users who have been assigned Roles within this Project.
roleLISTThe set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.

JSON Sample

XML Sample

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

Fields
NameTypeDescription
user-domainSTRINGThe 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-nameSTRINGThe 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.
roleLISTThe state of the Roles the User has been assigned.

JSON Sample

XML Sample

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

Fields
NameTypeDescription
roleSTRINGThe Role, independent of Keys.
stateSTRINGThe 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.

JSON Sample

XML Sample

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

Fields
NameTypeDescription
roleSTRINGThe Role, independent of Keys.
descriptionSTRINGA description of the Role.

JSON Sample

XML Sample

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

Fields
NameTypeDescription
vlrLIST

JSON Sample

XML Sample

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

Fields
NameTypeDescription
idSTRINGIdentifier for the VLR.
nameSTRINGVLR name.
nsr-id-refSTRINGNS instance identifier. This is a leafref /rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:id
vld-refSTRINGReference to VLD /rw-project:project/nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref] /nsd/vld:vld/vld:id
res-idSTRINGIdentifier for resmgr id mapping
short-nameSTRINGShort name to appear as label in the UI
vendorSTRINGProvider of the VLR.
descriptionSTRINGDescription of the VLR.
versionSTRINGVersion of the VLR
typeENUM
root-bandwidthUINT64For ELAN this is the aggregate bandwidth.
leaf-bandwidthUINT64For ELAN this is the bandwidth of branches.
create-timeUINT32Creation timestamp of this Virtual Link. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptimeUINT32Active period of this Virtual Link. Uptime is expressed in seconds
network-idSTRINGIdentifier for the allocated network resource.
vim-network-nameSTRINGName of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
provider-networkCONTAINERContainer for the provider network.
ip-profile-paramsCONTAINER
statusENUMStatus of the virtual link record.
operational-statusENUMThe 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.

JSON Sample

XML Sample

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

Fields
NameTypeDescription
physical-networkSTRINGName of the physical network on which the provider network is built.
segmentation_idUINT32ID of segregated virtual networks

JSON Sample

XML Sample

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

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

JSON Sample

XML Sample

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

Fields
NameTypeDescription
addressUNIONList of DNS Servers associated with IP Profile

JSON Sample

XML Sample

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

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

JSON Sample

XML Sample

vlr - User documentation

Schema Globals

Global Schema Type
rw_ypbc_Vlr_Vlr_t_schema
Global Schema Pointer
rw_ypbc_Vlr_Vlr_g_schema