Programmer's API documentation for yang module rw-cloud.yang



Schema Globals                                                               1

module rw-cloud                                                              2
  rw-cloud data                                                            2.1
    container rw-cloud:cloud                                             2.1.1
      list rw-cloud:account                                            2.1.1.1
        container rw-cloud:mock                                      2.1.1.1.1
        container rw-cloud:aws                                       2.1.1.1.2
        container rw-cloud:openstack                                 2.1.1.1.3
          leaf-list rw-cloud:security-groups                       2.1.1.1.3.1
        container rw-cloud:openmano                                  2.1.1.1.4
        container rw-cloud:vsphere                                   2.1.1.1.5
        container rw-cloud:cloudsim                                  2.1.1.1.6
        container rw-cloud:cloudsim_proxy                            2.1.1.1.7
        container rw-cloud:openvim                                   2.1.1.1.8
          container rw-cloud:image-management                      2.1.1.1.8.1
        container rw-cloud:connection-status                         2.1.1.1.9
  rw-cloud rpc input                                                       2.2
    rpc input rw-cloud:update-cloud-status                               2.2.1
  rw-cloud rpc output                                                      2.3
    rpc output rw-cloud:update-cloud-status                              2.3.1
  rw-cloud notification                                                    2.4
    notification rw-cloud:cloud-notif                                    2.4.1


1  Schema Globals
  Global Schema Type
    rw_ypbc_RwCloud_t_schema
  Global Schema Pointer
    rw_ypbc_RwCloud_g_schema
2  module rw-cloud

2.1  rw-cloud data

2.1.1  container rw-cloud:cloud
  XPath Path
    /rw-cloud:cloud
  XPath Keyed Path
    /rw-cloud:cloud
  RW.REST URI Path
    /rw-cloud:cloud
  RW Keyspec XPath Path
    C,/rw-cloud:cloud
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud
  RW Keyspec XPath Path
    D,/rw-cloud:cloud
  RW Keyspec XPath Keyed Path
    D,/rw-cloud:cloud
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud
  Python Proto-GI Type
    RwCloudYang.CloudConfig
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud
    RwCloud_data_Cloud
    RwCloud_CloudConfig
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud

2.1.1.1  list rw-cloud:account
  Description
    Configure Cloud Accounts
  Leaves
    name: name, type: STRING
    name: sdn-account, type: LEAFREF, description: Configured SDN account associated with this cloud account
    name: account-type, type: ENUM
  XPath Path
    /rw-cloud:cloud/rw-cloud:account
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']
  RW Keyspec XPath Path
    D,/rw-cloud:cloud/rw-cloud:account
  RW Keyspec XPath Keyed Path
    D,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account
  Python Proto-GI Type
    RwCloudYang.CloudAccount
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account
    RwCloud_data_Cloud_Account
    RwCloud_CloudAccount
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account

2.1.1.1.1  container rw-cloud:mock
  Leaves
    name: username, type: STRING
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:mock
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:mock
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/mock
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:mock
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:mock
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Mock
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Mock
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Mock
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Mock
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Mock

2.1.1.1.2  container rw-cloud:aws
  Leaves
    name: key, type: STRING
    name: secret, type: STRING
    name: region, type: STRING
    name: vpcid, type: STRING, description: VPC ID to use to instantiate EC2 instances
    name: ssh-key, type: STRING, description: Key pair name to connect to EC2 instance
    name: availability-zone, type: STRING, description: Availability zone where EC2 instance should
    be started
    name: default-subnet-id, type: STRING, description: Default subnet ID to create network
    interface at instance creation time
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:aws
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:aws
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/aws
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:aws
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:aws
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Aws
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Aws
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Aws
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Aws
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Aws

2.1.1.1.3  container rw-cloud:openstack
  Leaves
    name: key, type: STRING
    name: secret, type: STRING
    name: auth_url, type: STRING
    name: user-domain, type: STRING, description: Domain of the OpenStack user
    name: project-domain, type: STRING, description: Domain of the OpenStack project
    name: tenant, type: STRING
    name: region, type: STRING
    name: admin, type: BOOLEAN
    name: mgmt-network, type: STRING
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
    name: floating-ip-pool, type: STRING, description: Name of floating IP pool to use for floating IP address assignement
    name: cert-validate, type: BOOLEAN, description: Certificate validatation policy in case of SSL/TLS connection
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/openstack
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Openstack
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Openstack
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Openstack
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Openstack
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Openstack

2.1.1.1.3.1  leaf-list rw-cloud:security-groups
  Description
    Names of the security groups for the VM
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack/rw-cloud:security-groups
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack/rw-cloud:security-groups
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/openstack/security-groups
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack/rw-cloud:security-groups
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack/rw-cloud:security-groups
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Openstack.SecurityGroups
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Openstack_SecurityGroups
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Openstack__SecurityGroups
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Openstack_SecurityGroups
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Openstack_SecurityGroups

2.1.1.1.4  container rw-cloud:openmano
  Leaves
    name: host, type: STRING
    name: port, type: UINT16
    name: tenant-id, type: STRING
    name: plugin-name, type: STRING
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:openmano
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openmano
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/openmano
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:openmano
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openmano
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Openmano
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Openmano
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Openmano
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Openmano
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Openmano

2.1.1.1.5  container rw-cloud:vsphere
  Leaves
    name: username, type: STRING
    name: password, type: STRING
    name: url, type: STRING
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:vsphere
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:vsphere
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/vsphere
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:vsphere
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:vsphere
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Vsphere
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Vsphere
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Vsphere
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Vsphere
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Vsphere

2.1.1.1.6  container rw-cloud:cloudsim
  Leaves
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/cloudsim
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Cloudsim
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Cloudsim
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Cloudsim
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Cloudsim
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Cloudsim

2.1.1.1.7  container rw-cloud:cloudsim_proxy
  Leaves
    name: host, type: STRING
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim_proxy
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim_proxy
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/cloudsim_proxy
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim_proxy
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim_proxy
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.CloudsimProxy
  Python Proto-GI Type
    RwCloudYang.CloudAccount_CloudsimProxy
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__CloudsimProxy
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_CloudsimProxy
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_CloudsimProxy

2.1.1.1.8  container rw-cloud:openvim
  Leaves
    name: host, type: STRING
    name: port, type: UINT16
    name: tenant-name, type: STRING, description: Mandatory parameter to indicate openvim tenant name
    name: mgmt-network, type: STRING
    name: plugin-name, type: STRING
    name: dynamic-flavor-support, type: BOOLEAN
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/openvim
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Openvim
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Openvim
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Openvim
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Openvim
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Openvim

2.1.1.1.8.1  container rw-cloud:image-management
  Description
    Information required for OpenVim image upload operation
  Leaves
    name: username, type: STRING, description: Username for host access
    name: password, type: STRING, description: Password for host access
    name: image-directory-path, type: STRING, description: Name of the directory on the host where image needs to be copied
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim/rw-cloud:image-management
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim/rw-cloud:image-management
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/openvim/image-management
  RW Keyspec XPath Path
    C,/rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim/rw-cloud:image-management
  RW Keyspec XPath Keyed Path
    C,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim/rw-cloud:image-management
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.Openvim.ImageManagement
  Python Proto-GI Type
    RwCloudYang.CloudAccount_Openvim_ImageManagement
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__Openvim__ImageManagement
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_Openvim_ImageManagement
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_Openvim_ImageManagement

2.1.1.1.9  container rw-cloud:connection-status
  Leaves
    name: status, type: ENUM
    name: details, type: STRING
  XPath Path
    /rw-cloud:cloud/rw-cloud:account/rw-cloud:connection-status
  XPath Keyed Path
    /rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:connection-status
  RW.REST URI Path
    /rw-cloud:cloud/account/STRING/connection-status
  RW Keyspec XPath Path
    D,/rw-cloud:cloud/rw-cloud:account/rw-cloud:connection-status
  RW Keyspec XPath Keyed Path
    D,/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:connection-status
  Protobuf Type
    .rw_cloud.YangData.RwCloud.Cloud.Account.ConnectionStatus
  Python Proto-GI Type
    RwCloudYang.CloudAccount_ConnectionStatus
  C Protobuf-C Struct Type
    RwCloud__YangData__RwCloud__Cloud__Account__ConnectionStatus
  C RWPB Identifiers
    RwCloud_RwCloud_data_Cloud_Account_ConnectionStatus
    RwCloud_data_Cloud_Account_ConnectionStatus
    RwCloud_CloudAccount_ConnectionStatus
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_data_Cloud_Account_ConnectionStatus

2.2  rw-cloud rpc input

2.2.1  rpc input rw-cloud:update-cloud-status
  Leaves
    name: cloud-account, type: STRING, description: The cloud account name to update connection status for
  XPath Path
    /rw-cloud:update-cloud-status
  XPath Keyed Path
    /rw-cloud:update-cloud-status
  RW.REST URI Path
    /input
  RW Keyspec XPath Path
    I,/rw-cloud:update-cloud-status
  RW Keyspec XPath Keyed Path
    I,/rw-cloud:update-cloud-status
  Protobuf Type
    .rw_cloud.YangInput.RwCloud.UpdateCloudStatus
  Python Proto-GI Type
    RwCloudYang.YangInput_RwCloud_UpdateCloudStatus
  C Protobuf-C Struct Type
    RwCloud__YangInput__RwCloud__UpdateCloudStatus
  C RWPB Identifiers
    RwCloud_RwCloud_input_UpdateCloudStatus
    RwCloud_input_UpdateCloudStatus
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_input_UpdateCloudStatus

2.3  rw-cloud rpc output

2.3.1  rpc output rw-cloud:update-cloud-status
  XPath Path
    /rw-cloud:update-cloud-status
  XPath Keyed Path
    /rw-cloud:update-cloud-status
  RW.REST URI Path
    /output
  RW Keyspec XPath Path
    O,/rw-cloud:update-cloud-status
  RW Keyspec XPath Keyed Path
    O,/rw-cloud:update-cloud-status
  Protobuf Type
    .rw_cloud.YangOutput.RwCloud.UpdateCloudStatus
  Python Proto-GI Type
    RwCloudYang.YangOutput_RwCloud_UpdateCloudStatus
  C Protobuf-C Struct Type
    RwCloud__YangOutput__RwCloud__UpdateCloudStatus
  C RWPB Identifiers
    RwCloud_RwCloud_output_UpdateCloudStatus
    RwCloud_output_UpdateCloudStatus
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_output_UpdateCloudStatus

2.4  rw-cloud notification

2.4.1  notification rw-cloud:cloud-notif
  Description
    Notification for cloud account credentials
  Leaves
    name: name, type: STRING, description: Cloud account name
    name: message, type: STRING, description: Notification message
  XPath Path
    /rw-cloud:cloud-notif
  XPath Keyed Path
    /rw-cloud:cloud-notif
  RW.REST URI Path
    /rw-cloud:cloud-notif
  RW Keyspec XPath Path
    N,/rw-cloud:cloud-notif
  RW Keyspec XPath Keyed Path
    N,/rw-cloud:cloud-notif
  Protobuf Type
    .rw_cloud.YangNotif.RwCloud.CloudNotif
  Python Proto-GI Type
    RwCloudYang.YangNotif_RwCloud_CloudNotif
  C Protobuf-C Struct Type
    RwCloud__YangNotif__RwCloud__CloudNotif
  C RWPB Identifiers
    RwCloud_RwCloud_notif_CloudNotif
    RwCloud_notif_CloudNotif
  YPBC Base Identifier
    rw_ypbc_RwCloud_RwCloud_notif_CloudNotif

