rw-cloud - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_RwCloud_RwCloud_t_schema |
| Global Schema Pointer | rw_ypbc_RwCloud_RwCloud_g_schema |
rw-cloud data
rw-cloud:cloud
Key Identifiers:| XPath Path | /rw-cloud:cloud |
| XPath Keyed Path | /rw-cloud:cloud |
| RW.REST URI Path | /rw-cloud:cloud |
Fields
| Name | Type | Description |
|---|---|---|
| account | LIST | Configure Cloud Accounts |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:account
Configure Cloud Accounts
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | |
| sdn-account | LEAFREF | Configured SDN account associated with this cloud account |
| account-type | ENUM | |
| mock | CONTAINER | |
| aws | CONTAINER | |
| openstack | CONTAINER | |
| openmano | CONTAINER | |
| vsphere | CONTAINER | |
| cloudsim | CONTAINER | |
| cloudsim_proxy | CONTAINER | |
| openvim | CONTAINER | |
| connection-status | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:mock
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:aws
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | |
| secret | STRING | |
| region | STRING | |
| vpcid | STRING | VPC ID to use to instantiate EC2 instances |
| ssh-key | STRING | Key pair name to connect to EC2 instance |
| availability-zone | STRING | Availability zone where EC2 instance should be started |
| default-subnet-id | STRING | Default subnet ID to create network interface at instance creation time |
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:openstack
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | |
| secret | STRING | |
| auth_url | STRING | |
| user-domain | STRING | Domain of the OpenStack user |
| project-domain | STRING | Domain of the OpenStack project |
| tenant | STRING | |
| region | STRING | |
| admin | BOOLEAN | |
| mgmt-network | STRING | |
| plugin-name | STRING | |
| security-groups | LEAF_LIST | Names of the security groups for the VM |
| dynamic-flavor-support | BOOLEAN | |
| floating-ip-pool | STRING | Name of floating IP pool to use for floating IP address assignement |
| cert-validate | BOOLEAN | Certificate validatation policy in case of SSL/TLS connection |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:security-groups
Names of the security groups for the VM
Key Identifiers:| 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 |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:openmano
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| host | STRING | |
| port | UINT16 | |
| tenant-id | STRING | |
| plugin-name | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:vsphere
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | |
| password | STRING | |
| url | STRING | |
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:cloudsim
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:cloudsim_proxy
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| host | STRING | |
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:openvim
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| host | STRING | |
| port | UINT16 | |
| tenant-name | STRING | Mandatory parameter to indicate openvim tenant name |
| mgmt-network | STRING | |
| plugin-name | STRING | |
| dynamic-flavor-support | BOOLEAN | |
| image-management | CONTAINER | Information required for OpenVim image upload operation |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:image-management
Information required for OpenVim image upload operation
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| username | STRING | Username for host access |
| password | STRING | Password for host access |
| image-directory-path | STRING | Name of the directory on the host where image needs to be copied |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-cloud:connection-status
Key Identifiers:| 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 |
Fields
| Name | Type | Description |
|---|---|---|
| status | ENUM | |
| details | STRING |
JSON Sample
XML Sample
rw-cloud rpc input
rw-cloud:update-cloud-status
Key Identifiers:| XPath Path | /rw-cloud:update-cloud-status |
| XPath Keyed Path | /rw-cloud:update-cloud-status |
| RW.REST URI Path | /input |
Fields
| Name | Type | Description |
|---|---|---|
| cloud-account | STRING | The cloud account name to update connection status for |
JSON Sample
XML Sample
rw-cloud rpc output
rw-cloud:update-cloud-status
Key Identifiers:| XPath Path | /rw-cloud:update-cloud-status |
| XPath Keyed Path | /rw-cloud:update-cloud-status |
| RW.REST URI Path | /output |
JSON Sample
XML Sample
rw-cloud notification
rw-cloud:cloud-notif
Notification for cloud account credentials
Key Identifiers:| XPath Path | /rw-cloud:cloud-notif |
| XPath Keyed Path | /rw-cloud:cloud-notif |
| RW.REST URI Path | /rw-cloud:cloud-notif |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Cloud account name |
| message | STRING | Notification message |
JSON Sample
XML Sample