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
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.
sdnCONTAINER
sdn-accountsCONTAINER
vnffgsCONTAINER
vnffg-rendered-pathsCONTAINER
vnffg-classifiersCONTAINER

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

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
NameTypeDescription
accountLIST

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

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

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

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

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
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

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

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

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

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

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

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

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
NameTypeDescription
vnffg-chainLIST

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
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
/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
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
/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
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
/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
NameTypeDescription
port-idSTRING
vm-idSTRING
nameSTRING
addressUNION
portUINT16

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

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

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

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

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
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
/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
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
/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
NameTypeDescription
vnffg-classifierLIST

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
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
/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
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
/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
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

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
NameTypeDescription
sdn-accountSTRINGThe sdn account name to update connection status for
project-nameLEAFREFProject 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
NameTypeDescription
nameSTRINGSDN account name
messageSTRINGNotification message

JSON Sample

XML Sample