class ForemanApi::Resources::Domain

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/domain.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["domains"]
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] domain

allowed keys are:
* dns_id [String, nil] Dns proxy to use within this domain
* domain_parameters_attributes [Array] Array of parameters (name, value)
* fullname [String, nil] Full name describing the domain
* name [String] The full dns domain name

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

# File lib/foreman_api/resources/domain.rb, line 39
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/domain.rb, line 63
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/domain.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 May be numerical id or domain name

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

# File lib/foreman_api/resources/domain.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] domain

allowed keys are:
* dns_id [String, nil] Dns proxy to use within this domain
* domain_parameters_attributes [Array] Array of parameters (name, value)
* fullname [String, nil] Full name describing the domain
* name [String, nil] The full dns domain name

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

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