User documentation for yang module rw-sdn.yang

module rw-sdn                                                                1
  rw-sdn data                                                              1.1
    container rw-sdn:sdn                                                 1.1.1
      list rw-sdn:account                                              1.1.1.1
        container rw-sdn:odl                                         1.1.1.1.1
        container rw-sdn:mock                                        1.1.1.1.2
        container rw-sdn:sdnsim                                      1.1.1.1.3
        container rw-sdn:openstack                                   1.1.1.1.4
        container rw-sdn:connection-status                           1.1.1.1.5
  rw-sdn rpc input                                                         1.2
    rpc input rw-sdn:update-sdn-status                                   1.2.1
  rw-sdn rpc output                                                        1.3
    rpc output rw-sdn:update-sdn-status                                  1.3.1


1  module rw-sdn

1.1  rw-sdn data

1.1.1  container rw-sdn:sdn
  XPath Path
    /rw-sdn:sdn
  XPath Keyed Path
    /rw-sdn:sdn
  RW.REST URI Path
    /rw-sdn:sdn
  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>

1.1.1.1  list rw-sdn:account
  Leaves
    name: name, type: STRING
    name: account-type, type: ENUM
  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
  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>

1.1.1.1.1  container rw-sdn:odl
  Leaves
    name: username, type: STRING
    name: password, type: STRING
    name: url, type: STRING
    name: plugin-name, type: STRING
  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
  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>

1.1.1.1.2  container rw-sdn:mock
  Leaves
    name: username, type: STRING
    name: plugin-name, type: STRING
  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
  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>

1.1.1.1.3  container rw-sdn:sdnsim
  Leaves
    name: username, type: STRING
    name: topology-source, type: STRING
    name: plugin-name, type: STRING
  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
  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>

1.1.1.1.4  container rw-sdn:openstack
  Leaves
    name: key, type: STRING
    name: secret, type: STRING
    name: auth_url, type: STRING
    name: tenant, type: STRING
    name: admin, type: BOOLEAN
    name: user-domain, type: STRING, description: Domain of the OpenStack user
    name: project-domain, type: STRING, description: Domain of the OpenStack project
    name: region, type: STRING
    name: plugin-name, type: STRING
    name: cert-validate, type: BOOLEAN, description: Certificate validatation policy in case of SSL/TLS connection
  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
  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>

1.1.1.1.5  container rw-sdn:connection-status
  Leaves
    name: status, type: ENUM
    name: details, type: STRING
  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
  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>

1.2  rw-sdn rpc input

1.2.1  rpc input rw-sdn:update-sdn-status
  Leaves
    name: sdn-account, type: STRING, description: The sdn account name to update connection status for
  XPath Path
    /rw-sdn:update-sdn-status
  XPath Keyed Path
    /rw-sdn:update-sdn-status
  RW.REST URI Path
    /input
  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>

1.3  rw-sdn rpc output

1.3.1  rpc output rw-sdn:update-sdn-status
  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"/>

