rwsdnal - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_Rwsdnal_Rwsdnal_t_schema |
| Global Schema Pointer | rw_ypbc_Rwsdnal_Rwsdnal_g_schema |
rwsdnal data
rwsdnal:connection-status
Key Identifiers:| XPath Path | /rwsdnal:connection-status |
| XPath Keyed Path | /rwsdnal:connection-status |
| RW.REST URI Path | /rwsdnal:connection-status |
Fields
| Name | Type | Description |
|---|---|---|
| status | ENUM | |
| details | STRING |
JSON Sample
XML Sample
rwsdnal:sdn-accounts
Key Identifiers:| XPath Path | /rwsdnal:sdn-accounts |
| XPath Keyed Path | /rwsdnal:sdn-accounts |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:odl |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:odl |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:mock |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:mock |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:sdnsim |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:sdnsim |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:openstack |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:openstack |
| RW.REST URI Path | /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 | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:connection-status |
| XPath Keyed Path | /rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:connection-status |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs |
| XPath Keyed Path | /rwsdnal:vnffgs |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain |
| XPath Keyed Path | /rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path |
| XPath Keyed Path | /rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids |
| XPath Keyed Path | /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 | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids/rwsdnal:vdu-list |
| XPath Keyed Path | /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 | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff |
| XPath Keyed Path | /rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:dp-endpoints |
| XPath Keyed Path | /rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:dp-endpoints[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:vnfr-list |
| XPath Keyed Path | /rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:vnfr-list[rwsdnal:vnfr-name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-rendered-paths |
| XPath Keyed Path | /rwsdnal:vnffg-rendered-paths |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path |
| XPath Keyed Path | /rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop |
| XPath Keyed Path | /rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']/rwsdnal:rendered-path-hop[rwsdnal:hop-number='0'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop/rwsdnal:service-function-forwarder |
| XPath Keyed Path | /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 | /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 | /rwsdnal:vnffg-classifiers |
| XPath Keyed Path | /rwsdnal:vnffg-classifiers |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier |
| XPath Keyed Path | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:vnffg-metadata |
| XPath Keyed Path | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:vnffg-metadata |
| RW.REST URI Path | /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 | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:match-attributes |
| XPath Keyed Path | /rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:match-attributes[rwsdnal:name='STRING'] |
| RW.REST URI Path | /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