Class: ForemanApi::Resources::LookupKey

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

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

  • lookup_key (Hash)

    allowed keys are:

    • puppetclass_id [String]

    • default_value [String]

    • description [String]

    • is_param [String]

    • key [String]

    • key_type [String]

    • override [String]

    • path [String]

    • required [String]

    • validator_rule [String]

    • validator_type [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



46
47
48
# File 'lib/foreman_api/resources/lookup_key.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



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

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

- (Array) host_or_hostgroup_smart_class_parameters(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)
  • page (String)

    Paginate results

  • per_page (String)

    Number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) host_or_hostgroup_smart_parameters(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)
  • page (String)

    Paginate results

  • per_page (String)

    Number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

def host_or_hostgroup_smart_parameters(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/lookup_key.rb', line 16

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

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

  • environment_id (String)
  • puppetclass_id (String)
  • order (String)

    Sort results

  • page (String)

    Paginate results

  • per_page (String)

    Number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



126
127
128
# File 'lib/foreman_api/resources/lookup_key.rb', line 126

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

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

  • puppetclass_id (String)
  • order (String)

    Sort results

  • page (String)

    Paginate results

  • per_page (String)

    Number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



113
114
115
# File 'lib/foreman_api/resources/lookup_key.rb', line 113

def puppet_smart_parameters(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/lookup_key.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)
  • lookup_key (Hash)

    allowed keys are:

    • puppetclass_id [String]

    • default_value [String]

    • description [String]

    • is_param [String]

    • key [String]

    • key_type [String]

    • override [String]

    • path [String]

    • required [String]

    • validator_rule [String]

    • validator_type [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



68
69
70
# File 'lib/foreman_api/resources/lookup_key.rb', line 68

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