Class: ForemanApi::Resources::ComputeResource

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/compute_resource.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from ForemanApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["compute_resources"]
end

Instance Method Details

#available_images(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



84
85
86
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 84

def available_images(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • compute_resource (Hash, nil) —

    allowed keys are:

    • description [String, nil]

    • name [String, nil]

    • password [String, nil] password for ovirt, ec2, vmware, openstack. secret key for ec2

    • provider [String, nil] providers include libvirt, ovirt, ec2, vmware, openstack, rackspace

    • region [String, nil] for ec2 only

    • server [String, nil] for vmware

    • tenant [String, nil] for openstack only

    • url [String] url for libvirt, ovirt, and openstack

    • user [String, nil] username for ovirt, ec2, vmware, openstack. access key for ec2.

    • uuid [String, nil] for ovirt, vmware datacenter

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



45
46
47
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 45

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



75
76
77
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 75

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • order (String) —

    sort results

  • page (String) —

    paginate results

  • per_page (String) —

    number of entries per request

  • search (String) —

    filter results

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



16
17
18
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 16

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



25
26
27
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 25

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#update(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

  • params (Hash) (defaults to: {}) —

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {}) —

    additional http headers

Options Hash (params):

  • id (String)
  • compute_resource (Hash, nil) —

    allowed keys are:

    • description [String, nil]

    • name [String, nil]

    • password [String, nil] password for ovirt, ec2, vmware, openstack. secret key for ec2

    • provider [String, nil] providers include libvirt, ovirt, ec2, vmware, openstack, rackspace

    • region [String, nil] for ec2 only

    • server [String, nil] for vmware

    • tenant [String, nil] for openstack only

    • url [String] url for libvirt, ovirt, and openstack

    • user [String, nil] username for ovirt, ec2, vmware, openstack. access key for ec2.

    • uuid [String, nil] for ovirt, vmware datacenter

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



66
67
68
 
# File 'lib/foreman_api/resources/compute_resource.rb', line 66

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end