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

- (Object) create(params = { }, headers = { })

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 [String] Array of parameters (name, value) ,

    • fullname [String, nil] Full name describing the domain ,

    • name [String] The full dns domain name ,



40
41
42
43
44
 
# File 'lib/foreman_api/resources/domain.rb', line 40

def create(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/domains", params
  call(:post", url, params, headers)
end

- (Object) destroy(params = { }, headers = { })

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) 


66
67
68
69
70
 
# File 'lib/foreman_api/resources/domain.rb', line 66

def destroy(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/domains/:id", params
  call(:delete", url, params, headers)
end

- (Object) index(params = { }, headers = { })

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



15
16
17
18
19
 
# File 'lib/foreman_api/resources/domain.rb', line 15

def index(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/domains", params
  call(:get", url, params, headers)
end

- (Object) show(params = { }, headers = { })

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



25
26
27
28
29
 
# File 'lib/foreman_api/resources/domain.rb', line 25

def show(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/domains/:id", params
  call(:get", url, params, headers)
end

- (Object) update(params = { }, headers = { })

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 [String] Array of parameters (name, value) ,

    • fullname [String, nil] Full name describing the domain ,

    • name [String, nil] The full dns domain name ,



56
57
58
59
60
 
# File 'lib/foreman_api/resources/domain.rb', line 56

def update(params = { }, headers = { })
  check_params params, :allowed => true, :method => __method__
  url, params = fill_params_in_url "/api/domains/:id", params
  call(:put", url, params, headers)
end