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
NameTypeDescription
statusENUM
detailsSTRING

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
NameTypeDescription
sdn-account-listLIST

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
NameTypeDescription
nameSTRING
account-typeENUM
odlCONTAINER
mockCONTAINER
sdnsimCONTAINER
openstackCONTAINER
connection-statusCONTAINER

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
NameTypeDescription
usernameSTRING
passwordSTRING
urlSTRING
plugin-nameSTRING

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
NameTypeDescription
usernameSTRING
plugin-nameSTRING

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
NameTypeDescription
usernameSTRING
topology-sourceSTRING
plugin-nameSTRING

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
NameTypeDescription
keySTRING
secretSTRING
auth_urlSTRING
tenantSTRING
adminBOOLEAN
user-domainSTRINGDomain of the OpenStack user
project-domainSTRINGDomain of the OpenStack project
regionSTRING
plugin-nameSTRING
cert-validateBOOLEANCertificate 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
NameTypeDescription
statusENUM
detailsSTRING

JSON Sample

XML Sample

rwsdnal:vnffgs

Key Identifiers:
XPath Path
/rwsdnal:vnffgs
XPath Keyed Path
/rwsdnal:vnffgs
RW.REST URI Path
/rwsdnal:vnffgs

Fields
NameTypeDescription
vnffg-chainLIST

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
NameTypeDescription
nameSTRING
vnf-chain-pathLIST
sffLIST
classifier-nameSTRING

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
NameTypeDescription
orderUINT32 Order of the VNF in VNFFG chain
service-function-typeSTRING
nsh-awareBOOLEAN
transport-typeSTRING
vnfr-idsLIST

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
NameTypeDescription
vnfr-idSTRING
vnfr-nameSTRING
mgmt-addressUNION
mgmt-portUINT16
vdu-listLIST
sff-nameSTRINGSFF 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
NameTypeDescription
port-idSTRING
vm-idSTRING
nameSTRING
addressUNION
portUINT16

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
NameTypeDescription
nameSTRING
function-typeSTRING
mgmt-addressUNION
mgmt-portUINT16
dp-endpointsLIST
vnfr-listLIST

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
NameTypeDescription
nameSTRING
addressUNION
portUINT16

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
NameTypeDescription
vnfr-nameSTRING

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
NameTypeDescription
vnffg-rendered-pathLIST

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
NameTypeDescription
nameSTRING
path-idUINT32Unique Identifier for the service path
rendered-path-hopLIST

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
NameTypeDescription
hop-numberUINT8
service-indexUINT8Location within the service path
vnfr-nameSTRING
service-function-forwarderCONTAINER

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
NameTypeDescription
nameSTRINGService Function Forwarder name
ip-addressUNIONService Function Forwarder Data Plane IP address
portUINT16Service 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
NameTypeDescription
vnffg-classifierLIST

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
NameTypeDescription
nameSTRING
rsp-nameSTRING
rsp-idSTRING
port-idSTRING
vm-idSTRING
sff-nameSTRING
vnffg-metadataCONTAINER
match-attributesLISTList 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
NameTypeDescription
ctx1STRING
ctx2STRING
ctx3STRING
ctx4STRING

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
NameTypeDescription
nameSTRINGName for the Access list
ip-protoUINT8IP Protocol.
source-ip-addressUNIONSource IP address.
destination-ip-addressUNIONDestination IP address.
source-portUINT16Source port number.
destination-portUINT16Destination port number.

JSON Config Sample

JSON Sample

XML Config Sample

XML Sample