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 data

rw-sdn:sdn

Key Identifiers:

XPath Path	/rw-sdn:sdn
XPath Keyed Path	/rw-sdn:sdn
RW.REST URI Path	/rw-sdn:sdn

Fields

Name	Type	Description
account	LIST

JSON Config Sample

{
  "account": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... }
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "account": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... },
      "connection-status": { ... }
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:account>
    <rw-sdn:name>STRING</rw-sdn:name>
    <rw-sdn:account-type>odl</rw-sdn:account-type>
    <rw-sdn:odl>...</rw-sdn:odl>
    <rw-sdn:mock>...</rw-sdn:mock>
    <rw-sdn:sdnsim>...</rw-sdn:sdnsim>
    <rw-sdn:openstack>...</rw-sdn:openstack>
  </rw-sdn:account>
</rw-sdn:sdn>

XML Sample

<rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:account>
    <rw-sdn:name>STRING</rw-sdn:name>
    <rw-sdn:account-type>odl</rw-sdn:account-type>
    <rw-sdn:odl>...</rw-sdn:odl>
    <rw-sdn:mock>...</rw-sdn:mock>
    <rw-sdn:sdnsim>...</rw-sdn:sdnsim>
    <rw-sdn:openstack>...</rw-sdn:openstack>
    <rw-sdn:connection-status>...</rw-sdn:connection-status>
  </rw-sdn:account>
</rw-sdn:sdn>

rw-sdn:account

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']
RW.REST URI Path	/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

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    },
    "connection-status": {
      "status": "unknown",
      "details": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<rw-sdn:account xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:name>STRING</rw-sdn:name>
  <rw-sdn:account-type>odl</rw-sdn:account-type>
  <rw-sdn:odl>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:password>STRING</rw-sdn:password>
    <rw-sdn:url>STRING</rw-sdn:url>
    <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
  </rw-sdn:odl>
  <rw-sdn:mock>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
  </rw-sdn:mock>
  <rw-sdn:sdnsim>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
    <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
  </rw-sdn:sdnsim>
  <rw-sdn:openstack>
    <rw-sdn:key>STRING</rw-sdn:key>
    <rw-sdn:secret>STRING</rw-sdn:secret>
    <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
    <rw-sdn:tenant>STRING</rw-sdn:tenant>
    <rw-sdn:admin>false</rw-sdn:admin>
    <rw-sdn:user-domain>Default</rw-sdn:user-domain>
    <rw-sdn:project-domain>Default</rw-sdn:project-domain>
    <rw-sdn:region>RegionOne</rw-sdn:region>
    <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
    <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
  </rw-sdn:openstack>
</rw-sdn:account>

XML Sample

<rw-sdn:account xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:name>STRING</rw-sdn:name>
  <rw-sdn:account-type>odl</rw-sdn:account-type>
  <rw-sdn:odl>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:password>STRING</rw-sdn:password>
    <rw-sdn:url>STRING</rw-sdn:url>
    <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
  </rw-sdn:odl>
  <rw-sdn:mock>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
  </rw-sdn:mock>
  <rw-sdn:sdnsim>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
    <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
  </rw-sdn:sdnsim>
  <rw-sdn:openstack>
    <rw-sdn:key>STRING</rw-sdn:key>
    <rw-sdn:secret>STRING</rw-sdn:secret>
    <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
    <rw-sdn:tenant>STRING</rw-sdn:tenant>
    <rw-sdn:admin>false</rw-sdn:admin>
    <rw-sdn:user-domain>Default</rw-sdn:user-domain>
    <rw-sdn:project-domain>Default</rw-sdn:project-domain>
    <rw-sdn:region>RegionOne</rw-sdn:region>
    <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
    <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
  </rw-sdn:openstack>
  <rw-sdn:connection-status>
    <rw-sdn:status>unknown</rw-sdn:status>
    <rw-sdn:details>STRING</rw-sdn:details>
  </rw-sdn:connection-status>
</rw-sdn:account>

rw-sdn:odl

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account/rw-sdn:odl
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:odl
RW.REST URI Path	/rw-sdn:sdn/account/STRING/odl

Fields

Name	Type	Description
username	STRING
password	STRING
url	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

XML Config Sample

<rw-sdn:odl xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:password>STRING</rw-sdn:password>
  <rw-sdn:url>STRING</rw-sdn:url>
  <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
</rw-sdn:odl>

XML Sample

<rw-sdn:odl xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:password>STRING</rw-sdn:password>
  <rw-sdn:url>STRING</rw-sdn:url>
  <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
</rw-sdn:odl>

rw-sdn:mock

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account/rw-sdn:mock
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:mock
RW.REST URI Path	/rw-sdn:sdn/account/STRING/mock

Fields

Name	Type	Description
username	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

JSON Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

XML Config Sample

<rw-sdn:mock xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
</rw-sdn:mock>

XML Sample

<rw-sdn:mock xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
</rw-sdn:mock>

rw-sdn:sdnsim

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account/rw-sdn:sdnsim
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:sdnsim
RW.REST URI Path	/rw-sdn:sdn/account/STRING/sdnsim

Fields

Name	Type	Description
username	STRING
topology-source	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

JSON Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

XML Config Sample

<rw-sdn:sdnsim xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
  <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
</rw-sdn:sdnsim>

XML Sample

<rw-sdn:sdnsim xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
  <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
</rw-sdn:sdnsim>

rw-sdn:openstack

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account/rw-sdn:openstack
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:openstack
RW.REST URI Path	/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

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

XML Config Sample

<rw-sdn:openstack xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:key>STRING</rw-sdn:key>
  <rw-sdn:secret>STRING</rw-sdn:secret>
  <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
  <rw-sdn:tenant>STRING</rw-sdn:tenant>
  <rw-sdn:admin>false</rw-sdn:admin>
  <rw-sdn:user-domain>Default</rw-sdn:user-domain>
  <rw-sdn:project-domain>Default</rw-sdn:project-domain>
  <rw-sdn:region>RegionOne</rw-sdn:region>
  <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
  <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
</rw-sdn:openstack>

XML Sample

<rw-sdn:openstack xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:key>STRING</rw-sdn:key>
  <rw-sdn:secret>STRING</rw-sdn:secret>
  <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
  <rw-sdn:tenant>STRING</rw-sdn:tenant>
  <rw-sdn:admin>false</rw-sdn:admin>
  <rw-sdn:user-domain>Default</rw-sdn:user-domain>
  <rw-sdn:project-domain>Default</rw-sdn:project-domain>
  <rw-sdn:region>RegionOne</rw-sdn:region>
  <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
  <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
</rw-sdn:openstack>

rw-sdn:connection-status

Key Identifiers:

XPath Path	/rw-sdn:sdn/rw-sdn:account/rw-sdn:connection-status
XPath Keyed Path	/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:connection-status
RW.REST URI Path	/rw-sdn:sdn/account/STRING/connection-status

Fields

Name	Type	Description
status	ENUM
details	STRING

JSON Sample

{
  "status": "unknown",
  "details": "STRING"
}

XML Sample

<rw-sdn:connection-status xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:status>unknown</rw-sdn:status>
  <rw-sdn:details>STRING</rw-sdn:details>
</rw-sdn:connection-status>

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

JSON Sample

{
  "sdn-account": "STRING"
}

XML Sample

<rw-sdn:input xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:sdn-account>STRING</rw-sdn:sdn-account>
</rw-sdn:input>

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:output xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn"/>