Class: ForemanApi::Resources::Puppetclass

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



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

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

  • puppetclass (Hash, nil)

    allowed keys are:

    • name [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



42
43
44
# File 'lib/foreman_api/resources/puppetclass.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



63
64
65
# File 'lib/foreman_api/resources/puppetclass.rb', line 63

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

  • environment_id (String)

    id of nested environment

  • host_id (String)

    id of nested host

  • hostgroup_id (String)

    id of nested hostgroup

  • 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/puppetclass.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)

    id of puppetclass

  • environment_id (String)

    id of nested environment

  • host_id (String)

    id of nested host

  • hostgroup_id (String)

    id of nested hostgroup

Returns:

  • (Array)

    First item: parsed data; second item: raw body



31
32
33
# File 'lib/foreman_api/resources/puppetclass.rb', line 31

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

    allowed keys are:

    • name [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



54
55
56
# File 'lib/foreman_api/resources/puppetclass.rb', line 54

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