Class: ForemanApi::Resources::ConfigTemplate

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc 



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

def self.doc
  @doc ||= ForemanApi.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



86
87
88
 
# File 'lib/foreman_api/resources/config_template.rb', line 86

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:

    • operatingsystem_ids [Array] Array of operating systems id to associate the template with

    • 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 [Array] Array of template combinations (hostgroup_id, environment_id)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



42
43
44
 
# File 'lib/foreman_api/resources/config_template.rb', line 42

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



78
79
80
 
# File 'lib/foreman_api/resources/config_template.rb', line 78

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

  • 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/config_template.rb', line 16

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



69
70
71
 
# File 'lib/foreman_api/resources/config_template.rb', line 69

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



25
26
27
 
# File 'lib/foreman_api/resources/config_template.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)
  • config_template (Hash) —

    allowed keys are:

    • operatingsystem_ids [Array] Array of operating systems id to associate the template with

    • template_kind_id [String, nil] Not relevant for snippet

    • audit_comment [String, nil]

    • name [String] Template name

    • snippet [String]

    • template [String]

    • template_combinations_attributes [Array] Array of template combinations (hostgroup_id, environment_id)

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



60
61
62
 
# File 'lib/foreman_api/resources/config_template.rb', line 60

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