Class/Module Index [+]

Quicksearch

ForemanApi::Resources::Parameter

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/parameter.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["parameters"]
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 [String] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization @option params [Hash, nil] parameter

allowed keys are:
* name [String]
* value [String]

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

# File lib/foreman_api/resources/parameter.rb, line 53
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 id of parameter @option params [String] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization

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

# File lib/foreman_api/resources/parameter.rb, line 87
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] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization @option params [String] page paginate results @option params [String] per_page number of entries per request

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

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

@param [Hash] params a hash of params to be passed to the service @option params [String] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization

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

# File lib/foreman_api/resources/parameter.rb, line 101
def reset(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 id of parameter @option params [String] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization

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

# File lib/foreman_api/resources/parameter.rb, line 35
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 id of parameter @option params [String] domain_id id of domain @option params [String] host_id id of host @option params [String] hostgroup_id id of hostgroup @option params [String] location_id id of location @option params [String] operatingsystem_id id of operating system @option params [String] organization_id id of organization @option params [Hash, nil] parameter

allowed keys are:
* name [String]
* value [String]

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.