Class: ForemanApi::Resources::Domain

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc 



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

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

  • domain (Hash) —

    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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/foreman_api/resources/domain.rb', line 39

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/domain.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):

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

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

    may be numerical id or domain name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

    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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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