GET /api/compute_resources
List all compute resources

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

GET /api/compute_resources/:id
Show a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

POST /api/compute_resources
Create a compute resource

Params

Param name Description
compute_resource
required

Value: Must be a Hash
compute_resource[name]
required

Value: Must be String
compute_resource[provider]
optional , nil allowed

Providers include


Value: Must be String
compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt, and OpenStack


Value: Must be String
compute_resource[description]
optional , nil allowed

Value: Must be String
compute_resource[user]
optional , nil allowed

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


Value: Must be String
compute_resource[password]
optional , nil allowed

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


Value: Must be String
compute_resource[uuid]
optional , nil allowed

for oVirt, VMware Datacenter


Value: Must be String
compute_resource[region]
optional , nil allowed

for EC2 only


Value: Must be String
compute_resource[tenant]
optional , nil allowed

for OpenStack only


Value: Must be String
compute_resource[server]
optional , nil allowed

for VMware


Value: Must be String
compute_resource[set_console_password]
optional , nil allowed

for Libvirt and VMware only


Value: Must be 'true' or 'false'

PUT /api/compute_resources/:id
Update a compute resource

Params

Param name Description
id
required

Value: Must be String
compute_resource
required

Value: Must be a Hash
compute_resource[name]
optional

Value: Must be String
compute_resource[provider]
optional , nil allowed

Providers include


Value: Must be String
compute_resource[url]
optional , nil allowed

URL for Libvirt, oVirt, and OpenStack


Value: Must be String
compute_resource[description]
optional , nil allowed

Value: Must be String
compute_resource[user]
optional , nil allowed

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


Value: Must be String
compute_resource[password]
optional , nil allowed

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


Value: Must be String
compute_resource[uuid]
optional , nil allowed

for oVirt, VMware Datacenter


Value: Must be String
compute_resource[region]
optional , nil allowed

for EC2 only


Value: Must be String
compute_resource[tenant]
optional , nil allowed

for OpenStack only


Value: Must be String
compute_resource[server]
optional , nil allowed

for VMware


Value: Must be String
compute_resource[set_console_password]
optional , nil allowed

for Libvirt and VMware only


Value: Must be 'true' or 'false'

DELETE /api/compute_resources/:id
Delete a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_images
List available images for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_clusters
List available clusters for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_flavors
List available flavors for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_folders
List available folders for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_zones
List available zone for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

GET /api/compute_resources/:id/available_networks
List available networks for a compute resource

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks
List available networks for a compute resource cluster

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
optional

Value: Must be String

GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools
List resource pools for a compute resource cluster

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
cluster_id
required

Value: Must be String

GET /api/compute_resources/:id/available_storage_domains
List storage_domains for a compute resource

GET /api/compute_resources/:id/available_storage_domains
List storage domains for a compute resource

GET /api/compute_resources/:id/available_storage_domains/:storage_domain
List attributes for a given storage domain

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
storage_domain
optional

Value: Must be String

GET /api/compute_resources/:id/available_security_groups
List available security groups for a compute resource

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

PUT /api/compute_resources/:id/associate
Associate VMs to Hosts

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.