class ForemanApi::Resources::Hostgroup

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/hostgroup.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["hostgroups"]
end

Public Instance Methods

create(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [Hash] hostgroup

allowed keys are:
* architecture_id [String]
* domain_id [String]
* environment_id [String]
* medium_id [String]
* operatingsystem_id [String]
* parent_id [String]
* ptable_id [String]
* puppet_ca_proxy_id [String]
* puppet_proxy_id [String]
* subnet_id [String]
* name [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/hostgroup.rb, line 46
def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
destroy(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/hostgroup.rb, line 77
def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
index(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] order Sort results @option params [String] page Paginate results @option params [String] per_page Number of entries per request @option params [String] search Filter results

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/hostgroup.rb, line 16
def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
show(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/hostgroup.rb, line 25
def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
update(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id @option params [Hash] hostgroup

allowed keys are:
* architecture_id [String]
* domain_id [String]
* environment_id [String]
* medium_id [String]
* operatingsystem_id [String]
* parent_id [String]
* ptable_id [String]
* puppet_ca_proxy_id [String]
* puppet_proxy_id [String]
* subnet_id [String]
* name [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/hostgroup.rb, line 68
def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end