class ForemanApi::Resources::ComputeResource

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/compute_resource.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["compute_resources"]
end

Public Instance Methods

available_images(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 84
def available_images(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
create(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [Hash] compute_resource

allowed keys are:
* description [String]
* name [String]
* password [String]  password for ovirt, ec2, vmware, openstack. secret key for ec2 
* provider [String]  providers include libvirt, ovirt, ec2, vmware, openstack, rackspace, gce 
* region [String]  for ec2 only 
* server [String]  for vmware 
* tenant [String]  for openstack only 
* url [String]  url for libvirt, ovirt, and openstack 
* user [String]  username for ovirt, ec2, vmware, openstack. access key for ec2. 
* uuid [String]  for ovirt, vmware datacenter

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 45
def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
destroy(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 75
def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
index(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] order sort results @option params [String] page paginate results @option params [String] per_page number of entries per request @option params [String] search filter results

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 16
def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
show(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 25
def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
update(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id @option params [Hash] compute_resource

allowed keys are:
* description [String]
* name [String]
* password [String]  password for ovirt, ec2, vmware, openstack. secret key for ec2 
* provider [String]  providers include libvirt, ovirt, ec2, vmware, openstack, rackspace, gce 
* region [String]  for ec2 only 
* server [String]  for vmware 
* tenant [String]  for openstack only 
* url [String]  url for libvirt, ovirt, and openstack 
* user [String]  username for ovirt, ec2, vmware, openstack. access key for ec2. 
* uuid [String]  for ovirt, vmware datacenter

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/compute_resource.rb, line 66
def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end