Class: KatelloApi::Resources::System

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/system.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/system.rb', line 4

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

Instance Method Details

#activate(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):

  • content_view_id (String)
  • environment_id (String)
  • organization_id (Object) —

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

  • activation_keys (String)
  • facts (Hash, nil) —

    key-value hash of system-specific facts

  • installedProducts (String, nil) —

    list of products installed on the system

  • location (String) —

    physical of the system

  • name (String) —

    name of the system

  • serviceLevel (String, nil) —

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

  • type (String) —

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



46
47
48
 
# File 'lib/katello_api/resources/system.rb', line 46

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

#add_system_groups(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/systems/:id/system_groups path

  • system (Hash) —

    allowed keys are:

    • system_group_ids [String] list of group ids to add the system to

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



199
200
201
 
# File 'lib/katello_api/resources/system.rb', line 199

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

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

  • content_view_id (String)
  • environment_id (String)
  • facts (Hash, nil) —

    key-value hash of system-specific facts

  • installedProducts (String, nil) —

    list of products installed on the system

  • location (String) —

    physical of the system

  • name (String) —

    name of the system

  • serviceLevel (String, nil) —

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

  • type (String) —

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



20
21
22
 
# File 'lib/katello_api/resources/system.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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



103
104
105
 
# File 'lib/katello_api/resources/system.rb', line 103

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

#enabled_repos(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/systems/:id/enabled_repos path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



187
188
189
 
# File 'lib/katello_api/resources/system.rb', line 187

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

#errata(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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



139
140
141
 
# File 'lib/katello_api/resources/system.rb', line 139

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

#hypervisors_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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



28
29
30
 
# File 'lib/katello_api/resources/system.rb', line 28

def hypervisors_update(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/consumers path

  • organization_id (Object) —

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

  • pool_id (String) —

    filter systems by subscribed pool

  • name (String) —

    filter systems by name

  • search (String) —

    filter systems by advanced search query

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



85
86
87
 
# File 'lib/katello_api/resources/system.rb', line 85

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

#package_profile(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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



130
131
132
 
# File 'lib/katello_api/resources/system.rb', line 130

def package_profile(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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



112
113
114
 
# File 'lib/katello_api/resources/system.rb', line 112

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

#regenerate_identity_certificates(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 consumer

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

#releases(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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



121
122
123
 
# File 'lib/katello_api/resources/system.rb', line 121

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

#remove_system_groups(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/systems/:id/system_groups path

  • system (Hash) —

    allowed keys are:

    • system_group_ids [String] list of group ids to add the system to

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



211
212
213
 
# File 'lib/katello_api/resources/system.rb', line 211

def remove_system_groups(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/systems/report path

  • organization_id (Object) —

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



158
159
160
 
# File 'lib/katello_api/resources/system.rb', line 158

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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



94
95
96
 
# File 'lib/katello_api/resources/system.rb', line 94

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



178
179
180
 
# File 'lib/katello_api/resources/system.rb', line 178

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/systems/tasks path

  • system_name (String) —

    name of the system

  • system_uuid (String) —

    uuid of the system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



169
170
171
 
# File 'lib/katello_api/resources/system.rb', line 169

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/consumers/:id path

  • content_view_id (String)
  • environment_id (String)
  • facts (Hash, nil) —

    key-value hash of system-specific facts

  • installedProducts (String, nil) —

    list of products installed on the system

  • location (String) —

    physical of the system

  • name (String) —

    name of the system

  • serviceLevel (String, nil) —

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

  • type (String) —

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

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



72
73
74
 
# File 'lib/katello_api/resources/system.rb', line 72

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

#upload_package_profile(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 system

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



148
149
150
 
# File 'lib/katello_api/resources/system.rb', line 148

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