Class: ForemanApi::Resources::ComputeResource

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

- (Array) available_images(params = {}, headers = {})

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

- (Array) create(params = {}, headers = {})

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)

    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

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

- (Array) destroy(params = {}, headers = {})

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

- (Array) index(params = {}, headers = {})

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

- (Array) show(params = {}, headers = {})

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

- (Array) update(params = {}, headers = {})

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)

    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

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