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

  • distributor (Hash) —

    allowed keys are:

    • capabilities [Array, nil] list of subscription capabilities

    • facts [Hash, nil] key-value hash of distributor-specific facts

    • installedProducts [Array, nil] list of products installed on the distributor

    • location [String, nil] physical of the distributor

    • name [String] name of the distributor

    • releaseVer [String, nil] 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’

    • version [String, nil] version of the distributor. defaults to the latest if not given.

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



24
25
26
 
# File 'lib/katello_api/resources/distributor.rb', line 24

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



82
83
84
 
# File 'lib/katello_api/resources/distributor.rb', line 82

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

#export(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



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

def export(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



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

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



91
92
93
 
# File 'lib/katello_api/resources/distributor.rb', line 91

def pools(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



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

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



111
112
113
 
# File 'lib/katello_api/resources/distributor.rb', line 111

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



102
103
104
 
# File 'lib/katello_api/resources/distributor.rb', line 102

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

  • capabilities (Array) —

    for backwards capability with red hat hosted candlepin - list of subscription capabilities

  • distributor (Hash) —

    allowed keys are:

    • capabilities [Array, nil] list of subscription capabilities

    • facts [Hash, nil] key-value hash of distributor-specific facts

    • installedProducts [Array, nil] list of products installed on the distributor

    • location [String, nil] physical of the distributor

    • name [String] name of the distributor

    • releaseVer [String, nil] 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



43
44
45
 
# File 'lib/katello_api/resources/distributor.rb', line 43

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

#versions(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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



119
120
121
 
# File 'lib/katello_api/resources/distributor.rb', line 119

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