User documentation for yang module rw-config-agent.yang

module rw-config-agent                                                       1
  rw-config-agent data                                                     1.1
    container rw-config-agent:config-agent                               1.1.1
      list rw-config-agent:account                                     1.1.1.1
        container rw-config-agent:juju                               1.1.1.1.1
        container rw-config-agent:connection-status                  1.1.1.1.2
  rw-config-agent rpc input                                                1.2
    rpc input rw-config-agent:update-cfg-agent-status                    1.2.1
  rw-config-agent rpc output                                               1.3
    rpc output rw-config-agent:update-cfg-agent-status                   1.3.1


1  module rw-config-agent

1.1  rw-config-agent data

1.1.1  container rw-config-agent:config-agent
  XPath Path
    /rw-config-agent:config-agent
  XPath Keyed Path
    /rw-config-agent:config-agent
  RW.REST URI Path
    /rw-config-agent:config-agent
  JSON Config Sample
    {
      "account": [
        {
          "name": "STRING",
          "account-type": "riftca",
          "juju": { ... }
        }, {
          ...
        }
      ]
    }
  JSON Sample
    {
      "account": [
        {
          "name": "STRING",
          "account-type": "riftca",
          "juju": { ... },
          "connection-status": { ... }
        }, {
          ...
        }
      ]
    }
  XML Config Sample
    <rw-config-agent:config-agent xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:account>
        <rw-config-agent:name>STRING</rw-config-agent:name>
        <rw-config-agent:account-type>riftca</rw-config-agent:account-type>
        <rw-config-agent:juju>...</rw-config-agent:juju>
      </rw-config-agent:account>
    </rw-config-agent:config-agent>
  XML Sample
    <rw-config-agent:config-agent xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:account>
        <rw-config-agent:name>STRING</rw-config-agent:name>
        <rw-config-agent:account-type>riftca</rw-config-agent:account-type>
        <rw-config-agent:juju>...</rw-config-agent:juju>
        <rw-config-agent:connection-status>...</rw-config-agent:connection-status>
      </rw-config-agent:account>
    </rw-config-agent:config-agent>

1.1.1.1  list rw-config-agent:account
  Description
    List of configuration agent accounts
  Leaves
    name: name, type: STRING, description: Name of this config agent account
    name: account-type, type: ENUM, description: Default account type is Rift Configuration Agent (RiftCA)
  XPath Path
    /rw-config-agent:config-agent/rw-config-agent:account
  XPath Keyed Path
    /rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']
  RW.REST URI Path
    /rw-config-agent:config-agent/account/STRING
  JSON Config Sample
    [
      {
        "name": "STRING",
        "account-type": "riftca",
        "juju": {
          "ip-address": "UNION_VALUE",
          "port": 17070,
          "user": "user-admin",
          "secret": "STRING"
        }
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "name": "STRING",
        "account-type": "riftca",
        "juju": {
          "ip-address": "UNION_VALUE",
          "port": 17070,
          "user": "user-admin",
          "secret": "STRING"
        },
        "connection-status": {
          "status": "unknown",
          "details": "STRING"
        }
      }, {
        ...
      }
    ]
  XML Config Sample
    <rw-config-agent:account xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:name>STRING</rw-config-agent:name>
      <rw-config-agent:account-type>riftca</rw-config-agent:account-type>
      <rw-config-agent:juju>
        <rw-config-agent:ip-address>UNION_VALUE</rw-config-agent:ip-address>
        <rw-config-agent:port>17070</rw-config-agent:port>
        <rw-config-agent:user>user-admin</rw-config-agent:user>
        <rw-config-agent:secret>STRING</rw-config-agent:secret>
      </rw-config-agent:juju>
    </rw-config-agent:account>
  XML Sample
    <rw-config-agent:account xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:name>STRING</rw-config-agent:name>
      <rw-config-agent:account-type>riftca</rw-config-agent:account-type>
      <rw-config-agent:juju>
        <rw-config-agent:ip-address>UNION_VALUE</rw-config-agent:ip-address>
        <rw-config-agent:port>17070</rw-config-agent:port>
        <rw-config-agent:user>user-admin</rw-config-agent:user>
        <rw-config-agent:secret>STRING</rw-config-agent:secret>
      </rw-config-agent:juju>
      <rw-config-agent:connection-status>
        <rw-config-agent:status>unknown</rw-config-agent:status>
        <rw-config-agent:details>STRING</rw-config-agent:details>
      </rw-config-agent:connection-status>
    </rw-config-agent:account>

1.1.1.1.1  container rw-config-agent:juju
  Leaves
    name: ip-address, type: UNION, description: Juju host IP address.
    name: port, type: UINT16, description: Juju host port number. Default 17070.
    name: user, type: STRING, description: User name to connect to Juju host. Default user-admin.
    name: secret, type: STRING, description: Admin secret or password for Juju host.
  XPath Path
    /rw-config-agent:config-agent/rw-config-agent:account/rw-config-agent:juju
  XPath Keyed Path
    /rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']/rw-config-agent:juju
  RW.REST URI Path
    /rw-config-agent:config-agent/account/STRING/juju
  JSON Config Sample
    {
      "ip-address": "UNION_VALUE",
      "port": 17070,
      "user": "user-admin",
      "secret": "STRING"
    }
  JSON Sample
    {
      "ip-address": "UNION_VALUE",
      "port": 17070,
      "user": "user-admin",
      "secret": "STRING"
    }
  XML Config Sample
    <rw-config-agent:juju xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:ip-address>UNION_VALUE</rw-config-agent:ip-address>
      <rw-config-agent:port>17070</rw-config-agent:port>
      <rw-config-agent:user>user-admin</rw-config-agent:user>
      <rw-config-agent:secret>STRING</rw-config-agent:secret>
    </rw-config-agent:juju>
  XML Sample
    <rw-config-agent:juju xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:ip-address>UNION_VALUE</rw-config-agent:ip-address>
      <rw-config-agent:port>17070</rw-config-agent:port>
      <rw-config-agent:user>user-admin</rw-config-agent:user>
      <rw-config-agent:secret>STRING</rw-config-agent:secret>
    </rw-config-agent:juju>

1.1.1.1.2  container rw-config-agent:connection-status
  Leaves
    name: status, type: ENUM
    name: details, type: STRING
  XPath Path
    /rw-config-agent:config-agent/rw-config-agent:account/rw-config-agent:connection-status
  XPath Keyed Path
    /rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']/rw-config-agent:connection-status
  RW.REST URI Path
    /rw-config-agent:config-agent/account/STRING/connection-status
  JSON Sample
    {
      "status": "unknown",
      "details": "STRING"
    }
  XML Sample
    <rw-config-agent:connection-status xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:status>unknown</rw-config-agent:status>
      <rw-config-agent:details>STRING</rw-config-agent:details>
    </rw-config-agent:connection-status>

1.2  rw-config-agent rpc input

1.2.1  rpc input rw-config-agent:update-cfg-agent-status
  Leaves
    name: cfg-agent-account, type: STRING, description: The config agent account name to update connection status for
  XPath Path
    /rw-config-agent:update-cfg-agent-status
  XPath Keyed Path
    /rw-config-agent:update-cfg-agent-status
  RW.REST URI Path
    /input
  JSON Sample
    {
      "cfg-agent-account": "STRING"
    }
  XML Sample
    <rw-config-agent:input xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent">
      <rw-config-agent:cfg-agent-account>STRING</rw-config-agent:cfg-agent-account>
    </rw-config-agent:input>

1.3  rw-config-agent rpc output

1.3.1  rpc output rw-config-agent:update-cfg-agent-status
  XPath Path
    /rw-config-agent:update-cfg-agent-status
  XPath Keyed Path
    /rw-config-agent:update-cfg-agent-status
  RW.REST URI Path
    /output
  JSON Sample
    {
    }
  XML Sample
    <rw-config-agent:output xmlns:rw-config-agent="http://riftio.com/ns/riftware-1.0/rw-config-agent"/>

