Class: ForemanApi::Resources::SmartVariable

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc 



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

def self.doc
  @doc ||= ForemanApi.doc['resources']["smart_variables"]
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):

  • smart_variable (Hash, nil) —

    allowed keys are:

    • puppetclass_id [String, nil]

    • default_value [String, nil]

    • description [String, nil]

    • override_value_order [String, nil]

    • validator_rule [String, nil]

    • validator_type [String, nil]

    • variable [String]

    • variable_type [String, nil]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



46
47
48
 
# File 'lib/foreman_api/resources/smart_variable.rb', line 46

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



74
75
76
 
# File 'lib/foreman_api/resources/smart_variable.rb', line 74

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

  • host_id (String)
  • hostgroup_id (String)
  • puppetclass_id (String)
  • 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



19
20
21
 
# File 'lib/foreman_api/resources/smart_variable.rb', line 19

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



28
29
30
 
# File 'lib/foreman_api/resources/smart_variable.rb', line 28

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)
  • smart_variable (Hash, nil) —

    allowed keys are:

    • puppetclass_id [String, nil]

    • default_value [String, nil]

    • description [String, nil]

    • override_value_order [String, nil]

    • validator_rule [String, nil]

    • validator_type [String, nil]

    • variable [String]

    • variable_type [String, nil]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



65
66
67
 
# File 'lib/foreman_api/resources/smart_variable.rb', line 65

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