rw-config-agent - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwConfigAgent_RwConfigAgent_t_schema
Global Schema Pointer	rw_ypbc_RwConfigAgent_RwConfigAgent_g_schema

rw-config-agent data

rw-config-agent:config-agent

Key Identifiers:

XPath Path	/rw-config-agent:config-agent
XPath Keyed Path	/rw-config-agent:config-agent
RW.REST URI Path	/rw-config-agent:config-agent

Fields

Name	Type	Description
account	LIST	List of configuration agent accounts

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>

rw-config-agent:account

List of configuration agent accounts

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING	Name of this config agent account
account-type	ENUM	Default account type is Rift Configuration Agent (RiftCA)
juju	CONTAINER
connection-status	CONTAINER

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>

rw-config-agent:juju

Key Identifiers:

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

Fields

Name	Type	Description
ip-address	UNION	Juju host IP address.
port	UINT16	Juju host port number. Default 17070.
user	STRING	User name to connect to Juju host. Default user-admin.
secret	STRING	Admin secret or password for Juju host.

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>

rw-config-agent:connection-status

Key Identifiers:

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

Fields

Name	Type	Description
status	ENUM
details	STRING

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>

rw-config-agent rpc input

rw-config-agent:update-cfg-agent-status

Key Identifiers:

XPath Path	/rw-config-agent:update-cfg-agent-status
XPath Keyed Path	/rw-config-agent:update-cfg-agent-status
RW.REST URI Path	/input

Fields

Name	Type	Description
cfg-agent-account	STRING	The config agent account name to update connection status for

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>

rw-config-agent rpc output

rw-config-agent:update-cfg-agent-status

Key Identifiers:

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