Class: ForemanApi::Resources::Parameter

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

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

Instance Method Details

- (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):

  • domain_id (String)

    id of domain

  • host_id (String)

    id of host

  • hostgroup_id (String)

    id of hostgroup

  • operatingsystem_id (String)

    id of operating system

  • parameter (Hash)

    allowed keys are:

    • name [String]

    • value [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



47
48
49
# File 'lib/foreman_api/resources/parameter.rb', line 47

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)

    id of parameter

  • domain_id (String)

    id of domain

  • host_id (String)

    id of host

  • hostgroup_id (String)

    id of hostgroup

  • operatingsystem_id (String)

    id of operating system

Returns:

  • (Array)

    First item: parsed data; second item: raw body



77
78
79
# File 'lib/foreman_api/resources/parameter.rb', line 77

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):

  • domain_id (String)

    id of domain

  • host_id (String)

    id of host

  • hostgroup_id (String)

    id of hostgroup

  • operatingsystem_id (String)

    id of operating system

  • page (String)

    paginate results

  • per_page (String)

    number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



18
19
20
# File 'lib/foreman_api/resources/parameter.rb', line 18

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

- (Array) reset(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):

  • domain_id (Object)

    Part of /api/domains/:domain_id/parameters path

  • host_id (Object)

    Part of /api/hosts/:host_id/parameters path

  • hostgroup_id (Object)

    Part of /api/hostgroups/:hostgroup_id/parameters path

  • operatingsystem_id (Object)

    Part of /api/operatingsystems/:operatingsystem_id/parameters path

Returns:

  • (Array)

    First item: parsed data; second item: raw body



89
90
91
# File 'lib/foreman_api/resources/parameter.rb', line 89

def reset(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)

    id of parameter

  • domain_id (String)

    id of domain

  • host_id (String)

    id of host

  • hostgroup_id (String)

    id of hostgroup

  • operatingsystem_id (String)

    id of operating system

Returns:

  • (Array)

    First item: parsed data; second item: raw body



31
32
33
# File 'lib/foreman_api/resources/parameter.rb', line 31

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)

    id of parameter

  • domain_id (String)

    id of domain

  • host_id (String)

    id of host

  • hostgroup_id (String)

    id of hostgroup

  • operatingsystem_id (String)

    id of operating system

  • parameter (Hash)

    allowed keys are:

    • name [String]

    • value [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



64
65
66
# File 'lib/foreman_api/resources/parameter.rb', line 64

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