Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

  • String

compute_resource
required

Validations:

  • Hash

compute_resource[name]
optional

Validations:

  • String

compute_resource[provider]
optional , nil allowed

Providers include Libvirt, EC2, Vmware, Openstack

Validations:

  • String

compute_resource[url]
optional , nil allowed

URL for Libvirt and OpenStack

Validations:

  • String

compute_resource[description]
optional , nil allowed

Validations:

  • String

compute_resource[user]
optional , nil allowed

Username for EC2, VMware, OpenStack. Access Key for EC2.

Validations:

  • String

compute_resource[password]
optional , nil allowed

Password for EC2, VMware, OpenStack. Secret key for EC2

Validations:

  • String

compute_resource[datacenter]
optional , nil allowed

for VMware Datacenter

Validations:

  • String

compute_resource[region]
optional , nil allowed

for AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region

Validations:

  • String

compute_resource[tenant]
optional , nil allowed

for OpenStack and AzureRm only

Validations:

  • String

compute_resource[domain]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String

compute_resource[project_domain_name]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String

compute_resource[project_domain_id]
optional , nil allowed

for OpenStack (v3) only

Validations:

  • String

compute_resource[server]
optional , nil allowed

for VMware

Validations:

  • String

compute_resource[set_console_password]
optional , nil allowed

for Libvirt and VMware only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[display_type]
optional , nil allowed

for Libvirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[caching_enabled]
optional , nil allowed

enable caching, for VMware only

Validations:

  • Must be one of: true, false, 1, 0.

compute_resource[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

compute_resource[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type