User documentation for yang module rw-launchpad.yang

module rw-launchpad                                                          1
  rw-launchpad data                                                        1.1
    container rw-launchpad:datacenters                                   1.1.1
      list rw-launchpad:ro-accounts                                    1.1.1.1
        list rw-launchpad:datacenters                                1.1.1.1.1
    container rw-launchpad:resource-orchestrator                         1.1.2
      container rw-launchpad:rift-ro                                   1.1.2.1
      container rw-launchpad:openmano                                  1.1.2.2
    container rw-launchpad:launchpad-config                              1.1.3


1  module rw-launchpad

1.1  rw-launchpad data

1.1.1  container rw-launchpad:datacenters
  Description
    OpenMano data centers
  XPath Path
    /rw-launchpad:datacenters
  XPath Keyed Path
    /rw-launchpad:datacenters
  RW.REST URI Path
    /rw-launchpad:datacenters
  JSON Sample
    {
      "ro-accounts": [
        {
          "name": "STRING",
          "datacenters": [ { ... }, { ... } ]
        }, {
          ...
        }
      ]
    }
  XML Sample
    <rw-launchpad:datacenters xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:ro-accounts>
        <rw-launchpad:name>STRING</rw-launchpad:name>
        <rw-launchpad:datacenters>...</rw-launchpad:datacenters>
      </rw-launchpad:ro-accounts>
    </rw-launchpad:datacenters>

1.1.1.1  list rw-launchpad:ro-accounts
  Description
    A list of OpenMano cloud accounts that have data centers associated
    with them
  Leaves
    name: name, type: LEAFREF, description: The name of the cloud account
  XPath Path
    /rw-launchpad:datacenters/rw-launchpad:ro-accounts
  XPath Keyed Path
    /rw-launchpad:datacenters/rw-launchpad:ro-accounts[rw-launchpad:name='STRING']
  RW.REST URI Path
    /rw-launchpad:datacenters/ro-accounts/STRING
  JSON Sample
    [
      {
        "name": "STRING",
        "datacenters": [
          {
            "uuid": "STRING",
            "name": "STRING"
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <rw-launchpad:ro-accounts xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:name>STRING</rw-launchpad:name>
      <rw-launchpad:datacenters>
        <rw-launchpad:uuid>STRING</rw-launchpad:uuid>
        <rw-launchpad:name>STRING</rw-launchpad:name>
      </rw-launchpad:datacenters>
    </rw-launchpad:ro-accounts>

1.1.1.1.1  list rw-launchpad:datacenters
  Leaves
    name: uuid, type: STRING, description: The UUID of the data center
    name: name, type: STRING, description: The name of the data center
  XPath Path
    /rw-launchpad:datacenters/rw-launchpad:ro-accounts/rw-launchpad:datacenters
  XPath Keyed Path
    /rw-launchpad:datacenters/rw-launchpad:ro-accounts[rw-launchpad:name='STRING']/rw-launchpad:datacenters
  RW.REST URI Path
    /rw-launchpad:datacenters/ro-accounts/STRING/datacenters
  JSON Sample
    [
      {
        "uuid": "STRING",
        "name": "STRING"
      }, {
        ...
      }
    ]
  XML Sample
    <rw-launchpad:datacenters xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:uuid>STRING</rw-launchpad:uuid>
      <rw-launchpad:name>STRING</rw-launchpad:name>
    </rw-launchpad:datacenters>

1.1.2  container rw-launchpad:resource-orchestrator
  Leaves
    name: name, type: STRING
    name: account-type, type: ENUM
  XPath Path
    /rw-launchpad:resource-orchestrator
  XPath Keyed Path
    /rw-launchpad:resource-orchestrator
  RW.REST URI Path
    /rw-launchpad:resource-orchestrator
  JSON Config Sample
    {
      "name": "STRING",
      "account-type": "rift-ro",
      "rift-ro": {
        "rift-ro": [null]
      },
      "openmano": {
        "host": "localhost",
        "port": 9090,
        "tenant-id": "STRING"
      }
    }
  JSON Sample
    {
      "name": "STRING",
      "account-type": "rift-ro",
      "rift-ro": {
        "rift-ro": [null]
      },
      "openmano": {
        "host": "localhost",
        "port": 9090,
        "tenant-id": "STRING"
      }
    }
  XML Config Sample
    <rw-launchpad:resource-orchestrator xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:name>STRING</rw-launchpad:name>
      <rw-launchpad:account-type>rift-ro</rw-launchpad:account-type>
      <rw-launchpad:rift-ro>
        <rw-launchpad:rift-ro/>
      </rw-launchpad:rift-ro>
      <rw-launchpad:openmano>
        <rw-launchpad:host>localhost</rw-launchpad:host>
        <rw-launchpad:port>9090</rw-launchpad:port>
        <rw-launchpad:tenant-id>STRING</rw-launchpad:tenant-id>
      </rw-launchpad:openmano>
    </rw-launchpad:resource-orchestrator>
  XML Sample
    <rw-launchpad:resource-orchestrator xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:name>STRING</rw-launchpad:name>
      <rw-launchpad:account-type>rift-ro</rw-launchpad:account-type>
      <rw-launchpad:rift-ro>
        <rw-launchpad:rift-ro/>
      </rw-launchpad:rift-ro>
      <rw-launchpad:openmano>
        <rw-launchpad:host>localhost</rw-launchpad:host>
        <rw-launchpad:port>9090</rw-launchpad:port>
        <rw-launchpad:tenant-id>STRING</rw-launchpad:tenant-id>
      </rw-launchpad:openmano>
    </rw-launchpad:resource-orchestrator>

1.1.2.1  container rw-launchpad:rift-ro
  Leaves
    name: rift-ro, type: EMPTY
  XPath Path
    /rw-launchpad:resource-orchestrator/rw-launchpad:rift-ro
  XPath Keyed Path
    /rw-launchpad:resource-orchestrator/rw-launchpad:rift-ro
  RW.REST URI Path
    /rw-launchpad:resource-orchestrator/rift-ro
  JSON Config Sample
    {
      "rift-ro": [null]
    }
  JSON Sample
    {
      "rift-ro": [null]
    }
  XML Config Sample
    <rw-launchpad:rift-ro xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:rift-ro/>
    </rw-launchpad:rift-ro>
  XML Sample
    <rw-launchpad:rift-ro xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:rift-ro/>
    </rw-launchpad:rift-ro>

1.1.2.2  container rw-launchpad:openmano
  Leaves
    name: host, type: STRING
    name: port, type: UINT16
    name: tenant-id, type: STRING
  XPath Path
    /rw-launchpad:resource-orchestrator/rw-launchpad:openmano
  XPath Keyed Path
    /rw-launchpad:resource-orchestrator/rw-launchpad:openmano
  RW.REST URI Path
    /rw-launchpad:resource-orchestrator/openmano
  JSON Config Sample
    {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING"
    }
  JSON Sample
    {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING"
    }
  XML Config Sample
    <rw-launchpad:openmano xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:host>localhost</rw-launchpad:host>
      <rw-launchpad:port>9090</rw-launchpad:port>
      <rw-launchpad:tenant-id>STRING</rw-launchpad:tenant-id>
    </rw-launchpad:openmano>
  XML Sample
    <rw-launchpad:openmano xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:host>localhost</rw-launchpad:host>
      <rw-launchpad:port>9090</rw-launchpad:port>
      <rw-launchpad:tenant-id>STRING</rw-launchpad:tenant-id>
    </rw-launchpad:openmano>

1.1.3  container rw-launchpad:launchpad-config
  Leaves
    name: public-ip, type: STRING, description: An IP address that can, at least, be reached by the host that the
    launchpad is running on. This is not a mandatory but is required for
    alarms to function correctly.
  XPath Path
    /rw-launchpad:launchpad-config
  XPath Keyed Path
    /rw-launchpad:launchpad-config
  RW.REST URI Path
    /rw-launchpad:launchpad-config
  JSON Config Sample
    {
      "public-ip": "STRING"
    }
  JSON Sample
    {
      "public-ip": "STRING"
    }
  XML Config Sample
    <rw-launchpad:launchpad-config xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:public-ip>STRING</rw-launchpad:public-ip>
    </rw-launchpad:launchpad-config>
  XML Sample
    <rw-launchpad:launchpad-config xmlns:rw-launchpad="http://riftio.com/ns/riftware-1.0/rw-launchpad">
      <rw-launchpad:public-ip>STRING</rw-launchpad:public-ip>
    </rw-launchpad:launchpad-config>

