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

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

  • parameter (Hash, nil) —

    allowed keys are:

    • name [String]

    • value [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



53
54
55
 
# File 'lib/foreman_api/resources/parameter.rb', line 53

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

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



87
88
89
 
# File 'lib/foreman_api/resources/parameter.rb', line 87

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

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

  • page (String) —

    paginate results

  • per_page (String) —

    number of entries per request

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



20
21
22
 
# File 'lib/foreman_api/resources/parameter.rb', line 20

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 (String) —

    id of domain

  • host_id (String) —

    id of host

  • hostgroup_id (String) —

    id of hostgroup

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



101
102
103
 
# File 'lib/foreman_api/resources/parameter.rb', line 101

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

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



35
36
37
 
# File 'lib/foreman_api/resources/parameter.rb', line 35

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

  • location_id (String) —

    id of location

  • operatingsystem_id (String) —

    id of operating system

  • organization_id (String) —

    id of organization

  • parameter (Hash, nil) —

    allowed keys are:

    • name [String]

    • value [String]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



72
73
74
 
# File 'lib/foreman_api/resources/parameter.rb', line 72

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