Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

compute_resource
required

Validations:

  • Hash

compute_resource[name]
required

Validations:

  • String

compute_resource[provider]
optional , nil allowed

Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, Rackspace, GCE

Validations:

  • String

compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt, OpenStack and Rackspace

Validations:

  • String

compute_resource[description]
optional , nil allowed

Validations:

  • String

compute_resource[user]
optional , nil allowed

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

Validations:

  • String

compute_resource[password]
optional , nil allowed

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

Validations:

  • String

compute_resource[uuid]
optional , nil allowed

Deprecated, please use datacenter

Validations:

  • String

compute_resource[datacenter]
optional , nil allowed

for oVirt, VMware Datacenter

Validations:

  • String

compute_resource[use_v4]
optional , nil allowed

for oVirt only

Validations:

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

compute_resource[ovirt_quota]
optional , nil allowed

for oVirt only, ID of quota to use

Validations:

  • String

compute_resource[public_key]
optional , nil allowed

for oVirt only

Validations:

  • String

compute_resource[region]
optional , nil allowed

for EC2 only, use ‘us-gov-west-1’ for GovCloud region

Validations:

  • String

compute_resource[tenant]
optional , nil allowed

for OpenStack 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 and oVirt only

Validations:

  • Must be one of: VNC, SPICE.

compute_resource[keyboard]
optional , nil allowed

for oVirt only

Validations:

  • Must be one of: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr.

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