Programmer's API documentation for yang module rw-config-agent.yang



Schema Globals                                                               1

module rw-config-agent                                                       2
  rw-config-agent data                                                     2.1
    container rw-config-agent:config-agent                               2.1.1
      list rw-config-agent:account                                     2.1.1.1
        container rw-config-agent:juju                               2.1.1.1.1
        container rw-config-agent:connection-status                  2.1.1.1.2
  rw-config-agent rpc input                                                2.2
    rpc input rw-config-agent:update-cfg-agent-status                    2.2.1
  rw-config-agent rpc output                                               2.3
    rpc output rw-config-agent:update-cfg-agent-status                   2.3.1


1  Schema Globals
  Global Schema Type
    rw_ypbc_RwConfigAgent_t_schema
  Global Schema Pointer
    rw_ypbc_RwConfigAgent_g_schema
2  module rw-config-agent

2.1  rw-config-agent data

2.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
  RW Keyspec XPath Path
    C,/rw-config-agent:config-agent
  RW Keyspec XPath Keyed Path
    C,/rw-config-agent:config-agent
  RW Keyspec XPath Path
    D,/rw-config-agent:config-agent
  RW Keyspec XPath Keyed Path
    D,/rw-config-agent:config-agent
  Protobuf Type
    .rw_config_agent.YangData.RwConfigAgent.ConfigAgent
  Python Proto-GI Type
    RwConfigAgentYang.ConfigAgent
  C Protobuf-C Struct Type
    RwConfigAgent__YangData__RwConfigAgent__ConfigAgent
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_data_ConfigAgent
    RwConfigAgent_data_ConfigAgent
    RwConfigAgent_ConfigAgent
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_data_ConfigAgent

2.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
  RW Keyspec XPath Path
    C,/rw-config-agent:config-agent/rw-config-agent:account
  RW Keyspec XPath Keyed Path
    C,/rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']
  RW Keyspec XPath Path
    D,/rw-config-agent:config-agent/rw-config-agent:account
  RW Keyspec XPath Keyed Path
    D,/rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']
  Protobuf Type
    .rw_config_agent.YangData.RwConfigAgent.ConfigAgent.Account
  Python Proto-GI Type
    RwConfigAgentYang.ConfigAgentAccount
  C Protobuf-C Struct Type
    RwConfigAgent__YangData__RwConfigAgent__ConfigAgent__Account
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account
    RwConfigAgent_data_ConfigAgent_Account
    RwConfigAgent_ConfigAgentAccount
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account

2.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
  RW Keyspec XPath Path
    C,/rw-config-agent:config-agent/rw-config-agent:account/rw-config-agent:juju
  RW Keyspec XPath Keyed Path
    C,/rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']/rw-config-agent:juju
  Protobuf Type
    .rw_config_agent.YangData.RwConfigAgent.ConfigAgent.Account.Juju
  Python Proto-GI Type
    RwConfigAgentYang.ConfigAgentAccount_Juju
  C Protobuf-C Struct Type
    RwConfigAgent__YangData__RwConfigAgent__ConfigAgent__Account__Juju
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account_Juju
    RwConfigAgent_data_ConfigAgent_Account_Juju
    RwConfigAgent_ConfigAgentAccount_Juju
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account_Juju

2.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
  RW Keyspec XPath Path
    D,/rw-config-agent:config-agent/rw-config-agent:account/rw-config-agent:connection-status
  RW Keyspec XPath Keyed Path
    D,/rw-config-agent:config-agent/rw-config-agent:account[rw-config-agent:name='STRING']/rw-config-agent:connection-status
  Protobuf Type
    .rw_config_agent.YangData.RwConfigAgent.ConfigAgent.Account.ConnectionStatus
  Python Proto-GI Type
    RwConfigAgentYang.ConfigAgentAccount_ConnectionStatus
  C Protobuf-C Struct Type
    RwConfigAgent__YangData__RwConfigAgent__ConfigAgent__Account__ConnectionStatus
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account_ConnectionStatus
    RwConfigAgent_data_ConfigAgent_Account_ConnectionStatus
    RwConfigAgent_ConfigAgentAccount_ConnectionStatus
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_data_ConfigAgent_Account_ConnectionStatus

2.2  rw-config-agent rpc input

2.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
  RW Keyspec XPath Path
    I,/rw-config-agent:update-cfg-agent-status
  RW Keyspec XPath Keyed Path
    I,/rw-config-agent:update-cfg-agent-status
  Protobuf Type
    .rw_config_agent.YangInput.RwConfigAgent.UpdateCfgAgentStatus
  Python Proto-GI Type
    RwConfigAgentYang.YangInput_RwConfigAgent_UpdateCfgAgentStatus
  C Protobuf-C Struct Type
    RwConfigAgent__YangInput__RwConfigAgent__UpdateCfgAgentStatus
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_input_UpdateCfgAgentStatus
    RwConfigAgent_input_UpdateCfgAgentStatus
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_input_UpdateCfgAgentStatus

2.3  rw-config-agent rpc output

2.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
  RW Keyspec XPath Path
    O,/rw-config-agent:update-cfg-agent-status
  RW Keyspec XPath Keyed Path
    O,/rw-config-agent:update-cfg-agent-status
  Protobuf Type
    .rw_config_agent.YangOutput.RwConfigAgent.UpdateCfgAgentStatus
  Python Proto-GI Type
    RwConfigAgentYang.YangOutput_RwConfigAgent_UpdateCfgAgentStatus
  C Protobuf-C Struct Type
    RwConfigAgent__YangOutput__RwConfigAgent__UpdateCfgAgentStatus
  C RWPB Identifiers
    RwConfigAgent_RwConfigAgent_output_UpdateCfgAgentStatus
    RwConfigAgent_output_UpdateCfgAgentStatus
  YPBC Base Identifier
    rw_ypbc_RwConfigAgent_RwConfigAgent_output_UpdateCfgAgentStatus

