rw-project - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_RwSdn_RwProject_t_schema |
| Global Schema Pointer | rw_ypbc_RwSdn_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
| 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. |
| sdn | CONTAINER | |
| sdn-accounts | CONTAINER | |
| vnffgs | CONTAINER | |
| vnffg-rendered-paths | CONTAINER | |
| vnffg-classifiers | CONTAINER |
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
| Name | Type | Description |
|---|---|---|
| user | LIST | The 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
| 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. |
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
| Name | Type | Description |
|---|---|---|
| role | STRING | The 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
| 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. |
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
| 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. |
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
| 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. |
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
| Name | Type | Description |
|---|---|---|
| role | STRING | The Role, independent of Keys. |
| description | STRING | A description of the Role. |
JSON Sample
XML Sample
rw-sdn:sdn
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn |
Fields
| Name | Type | Description |
|---|---|---|
| account | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:account
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| account-type | ENUM | |
| odl | CONTAINER | |
| mock | CONTAINER | |
| sdnsim | CONTAINER | |
| openstack | CONTAINER | |
| connection-status | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:odl
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:odl |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:odl |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING/odl |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| password | STRING | |
| url | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:mock
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:mock |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:mock |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING/mock |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:sdnsim
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:sdnsim |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:sdnsim |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING/sdnsim |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| topology-source | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:openstack
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:openstack |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:openstack |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING/openstack |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | |
| secret | STRING | |
| auth_url | STRING | |
| tenant | STRING | |
| admin | BOOLEAN | |
| user-domain | STRING | Domain of the OpenStack user |
| project-domain | STRING | Domain of the OpenStack project |
| region | STRING | |
| plugin-name | STRING | |
| cert-validate | BOOLEAN | Certificate validatation policy in case of SSL/TLS connection |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn:connection-status
Key Identifiers:| XPath Path | /rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:connection-status |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:connection-status |
| RW.REST URI Path | /rw-project:project/STRING/rw-sdn:sdn/account/STRING/connection-status |
Fields
| Name | Type | Description |
|---|---|---|
| status | ENUM | |
| details | STRING |
JSON Sample
XML Sample
rwsdnal:sdn-accounts
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts |
Fields
| Name | Type | Description |
|---|---|---|
| sdn-account-list | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:sdn-account-list
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| account-type | ENUM | |
| odl | CONTAINER | |
| mock | CONTAINER | |
| sdnsim | CONTAINER | |
| openstack | CONTAINER | |
| connection-status | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:odl
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:odl |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:odl |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/odl |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| password | STRING | |
| url | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:mock
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:mock |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:mock |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/mock |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:sdnsim
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:sdnsim |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:sdnsim |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/sdnsim |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| topology-source | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:openstack
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:openstack |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:openstack |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/openstack |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | |
| secret | STRING | |
| auth_url | STRING | |
| tenant | STRING | |
| admin | BOOLEAN | |
| user-domain | STRING | Domain of the OpenStack user |
| project-domain | STRING | Domain of the OpenStack project |
| region | STRING | |
| plugin-name | STRING | |
| cert-validate | BOOLEAN | Certificate validatation policy in case of SSL/TLS connection |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:connection-status
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:connection-status |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:connection-status |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/connection-status |
Fields
| Name | Type | Description |
|---|---|---|
| status | ENUM | |
| details | STRING |
JSON Sample
XML Sample
rwsdnal:vnffgs
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs |
Fields
| Name | Type | Description |
|---|---|---|
| vnffg-chain | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnffg-chain
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| vnf-chain-path | LIST | |
| sff | LIST | |
| classifier-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnf-chain-path
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0 |
Fields
| Name | Type | Description |
|---|---|---|
| order | UINT32 | Order of the VNF in VNFFG chain |
| service-function-type | STRING | |
| nsh-aware | BOOLEAN | |
| transport-type | STRING | |
| vnfr-ids | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnfr-ids
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0']/rwsdnal:vnfr-ids[rwsdnal:vnfr-id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0/vnfr-ids/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| vnfr-id | STRING | |
| vnfr-name | STRING | |
| mgmt-address | UNION | |
| mgmt-port | UINT16 | |
| vdu-list | LIST | |
| sff-name | STRING | SFF name useful for non OVS based SFF |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vdu-list
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids/rwsdnal:vdu-list |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0']/rwsdnal:vnfr-ids[rwsdnal:vnfr-id='STRING']/rwsdnal:vdu-list[rwsdnal:vm-id='STRING'][rwsdnal:port-id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0/vnfr-ids/STRING/vdu-list/STRING,STRING |
Fields
| Name | Type | Description |
|---|---|---|
| port-id | STRING | |
| vm-id | STRING | |
| name | STRING | |
| address | UNION | |
| port | UINT16 |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:sff
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| function-type | STRING | |
| mgmt-address | UNION | |
| mgmt-port | UINT16 | |
| dp-endpoints | LIST | |
| vnfr-list | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:dp-endpoints
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:dp-endpoints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:dp-endpoints[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING/dp-endpoints/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| address | UNION | |
| port | UINT16 |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnfr-list
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:vnfr-list |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:vnfr-list[rwsdnal:vnfr-name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING/vnfr-list/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| vnfr-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnffg-rendered-paths
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-rendered-paths |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-rendered-paths |
Fields
| Name | Type | Description |
|---|---|---|
| vnffg-rendered-path | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnffg-rendered-path
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| path-id | UINT32 | Unique Identifier for the service path |
| rendered-path-hop | LIST |
JSON Sample
XML Sample
rwsdnal:rendered-path-hop
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']/rwsdnal:rendered-path-hop[rwsdnal:hop-number='0'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING/rendered-path-hop/0 |
Fields
| Name | Type | Description |
|---|---|---|
| hop-number | UINT8 | |
| service-index | UINT8 | Location within the service path |
| vnfr-name | STRING | |
| service-function-forwarder | CONTAINER |
JSON Sample
XML Sample
rwsdnal:service-function-forwarder
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop/rwsdnal:service-function-forwarder |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']/rwsdnal:rendered-path-hop[rwsdnal:hop-number='0']/rwsdnal:service-function-forwarder |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING/rendered-path-hop/0/service-function-forwarder |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Service Function Forwarder name |
| ip-address | UNION | Service Function Forwarder Data Plane IP address |
| port | UINT16 | Service Function Forwarder Data Plane port |
JSON Sample
XML Sample
rwsdnal:vnffg-classifiers
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-classifiers |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-classifiers |
Fields
| Name | Type | Description |
|---|---|---|
| vnffg-classifier | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnffg-classifier
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| rsp-name | STRING | |
| rsp-id | STRING | |
| port-id | STRING | |
| vm-id | STRING | |
| sff-name | STRING | |
| vnffg-metadata | CONTAINER | |
| match-attributes | LIST | List of match attributes. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:vnffg-metadata
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:vnffg-metadata |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:vnffg-metadata |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING/vnffg-metadata |
Fields
| Name | Type | Description |
|---|---|---|
| ctx1 | STRING | |
| ctx2 | STRING | |
| ctx3 | STRING | |
| ctx4 | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rwsdnal:match-attributes
List of match attributes.
Key Identifiers:| XPath Path | /rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:match-attributes |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:match-attributes[rwsdnal:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING/match-attributes/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name for the Access list |
| 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. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-sdn - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_RwSdn_RwSdn_t_schema |
| Global Schema Pointer | rw_ypbc_RwSdn_RwSdn_g_schema |
rw-sdn rpc input
rw-sdn:update-sdn-status
Key Identifiers:| XPath Path | /rw-sdn:update-sdn-status |
| XPath Keyed Path | /rw-sdn:update-sdn-status |
| RW.REST URI Path | /input |
Fields
| Name | Type | Description |
|---|---|---|
| sdn-account | STRING | The sdn account name to update connection status for |
| project-name | LEAFREF | Project to which this belongs |
JSON Sample
XML Sample
rw-sdn rpc output
rw-sdn:update-sdn-status
Key Identifiers:| XPath Path | /rw-sdn:update-sdn-status |
| XPath Keyed Path | /rw-sdn:update-sdn-status |
| RW.REST URI Path | /output |
JSON Sample
XML Sample
rw-sdn notification
rw-sdn:sdn-notif
Notification for SDN account credentials
Key Identifiers:| XPath Path | /rw-sdn:sdn-notif |
| XPath Keyed Path | /rw-sdn:sdn-notif |
| RW.REST URI Path | /rw-sdn:sdn-notif |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | SDN account name |
| message | STRING | Notification message |
JSON Sample
XML Sample