Class: KatelloApi::Resources::Distributor

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/distributor.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/katello_api/resources/distributor.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["distributors"]
end

Instance Method Details

#create(params = {}, headers = {}) ⇒ Array

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

  • environment_id (Object) —

    Part of /api/environments/:environment_id/distributors path

  • facts (Hash) —

    key-value hash of distributor-specific facts

  • installedProducts (String) —

    list of products installed on the distributor

  • location (String) —

    physical of the distributor

  • name (String) —

    name of the distributor

  • releaseVer (String) —

    release of the os. the $releasever variable in repo url will be replaced with this value

  • serviceLevel (String, nil) —

    a service level for auto-healing process, e.g. self-support

  • type (String) —

    type of the distributor, it should always be ‘distributor’

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



20
21
22
 
# File 'lib/katello_api/resources/distributor.rb', line 20

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

#destroy(params = {}, headers = {}) ⇒ Array

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

    uuid of the distributor

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



65
66
67
 
# File 'lib/katello_api/resources/distributor.rb', line 65

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

#index(params = {}, headers = {}) ⇒ Array

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

  • environment_id (Object) —

    Part of /api/environments/:environment_id/distributors path

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/distributors path

  • pool_id (String) —

    filter distributors by subscribed pool

  • name (String) —

    filter distributors by name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



47
48
49
 
# File 'lib/katello_api/resources/distributor.rb', line 47

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

#pools(params = {}, headers = {}) ⇒ Array

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

    uuid of the distributor

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



74
75
76
 
# File 'lib/katello_api/resources/distributor.rb', line 74

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

#report(params = {}, headers = {}) ⇒ Array

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

  • environment_id (Object) —

    Part of /api/environments/:environment_id/distributors/report path

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/distributors/report path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



84
85
86
 
# File 'lib/katello_api/resources/distributor.rb', line 84

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

#show(params = {}, headers = {}) ⇒ Array

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

    uuid of the distributor

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



56
57
58
 
# File 'lib/katello_api/resources/distributor.rb', line 56

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

#task_show(params = {}, headers = {}) ⇒ Array

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

    uuid of the task

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



104
105
106
 
# File 'lib/katello_api/resources/distributor.rb', line 104

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

#tasks(params = {}, headers = {}) ⇒ Array

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

  • organization_id (Object) —

    Part of /api/organizations/:organization_id/distributors/tasks path

  • distributor_name (String) —

    name of the distributor

  • distributor_uuid (String) —

    uuid of the distributor

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



95
96
97
 
# File 'lib/katello_api/resources/distributor.rb', line 95

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

#update(params = {}, headers = {}) ⇒ Array

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

    Part of /api/distributors/:id path

  • facts (Hash) —

    key-value hash of distributor-specific facts

  • installedProducts (String) —

    list of products installed on the distributor

  • location (String) —

    physical of the distributor

  • name (String) —

    name of the distributor

  • releaseVer (String) —

    release of the os. the $releasever variable in repo url will be replaced with this value

  • serviceLevel (String, nil) —

    a service level for auto-healing process, e.g. self-support

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



35
36
37
 
# File 'lib/katello_api/resources/distributor.rb', line 35

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