Class: KatelloApi::Resources::ConfigTemplate

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/config_template.rb

Constant Summary

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

+ (Object) doc 



4
5
6
 
# File 'lib/katello_api/resources/config_template.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["config_templates"]
end

Instance Method Details

- (Array) build_pxe_default(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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



82
83
84
 
# File 'lib/katello_api/resources/config_template.rb', line 82

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

  • config_template (Hash) —

    allowed keys are:

    • template_kind_id [String, nil] not relevant for snippet

    • audit_comment [String, nil]

    • name [String] template name

    • snippet [String, nil]

    • template [String]

    • template_combinations_attributes [String, nil] array of template combinations (hostgroup_id, environment_id)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/katello_api/resources/config_template.rb', line 39

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

    Part of /api/config_templates/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



65
66
67
 
# File 'lib/katello_api/resources/config_template.rb', line 65

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

  • search (String) —

    filter results

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/katello_api/resources/config_template.rb', line 14

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

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

  • version (String) —

    template version

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



74
75
76
 
# File 'lib/katello_api/resources/config_template.rb', line 74

def revision(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 (Object) —

    Part of /api/config_templates/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



23
24
25
 
# File 'lib/katello_api/resources/config_template.rb', line 23

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

    Part of /api/config_templates/:id path

  • config_template (Hash) —

    allowed keys are:

    • template_kind_id [String, nil] not relevant for snippet

    • audit_comment [String, nil]

    • name [String] template name

    • snippet [String, nil]

    • template [String]

    • template_combinations_attributes [String, nil] array of template combinations (hostgroup_id, environment_id)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



56
57
58
 
# File 'lib/katello_api/resources/config_template.rb', line 56

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