Class: KatelloApi::Resources::SystemGroup

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

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

Instance Method Details

#add_systems(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) —

    id of the system group

  • organization_id (String) —

    organization identifier

  • system_group (Hash) —

    allowed keys are:

    • system_ids [String] array of system ids

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



62
63
64
 
# File 'lib/katello_api/resources/system_group.rb', line 62

def add_systems(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):

  • organization_id (String) —

    organization identifier

  • system_group (Hash) —

    allowed keys are:

    • description [String, nil]

    • max_systems [Numeric, nil] maximum number of systems in the group

    • name [String] system group name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



110
111
112
 
# File 'lib/katello_api/resources/system_group.rb', line 110

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

    id of the system group

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



120
121
122
 
# File 'lib/katello_api/resources/system_group.rb', line 120

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

#history(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) —

    id of the system group

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

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

    id of the system group

  • job_id (String) —

    id of a job for filtering

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



96
97
98
 
# File 'lib/katello_api/resources/system_group.rb', line 96

def history_show(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):

  • organization_id (String) —

    organization identifier

  • name (String) —

    system group name to filter by

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



14
15
16
 
# File 'lib/katello_api/resources/system_group.rb', line 14

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

#remove_systems(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) —

    id of the system group

  • organization_id (String) —

    organization identifier

  • system_group (Hash) —

    allowed keys are:

    • system_ids [String] array of system ids

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



75
76
77
 
# File 'lib/katello_api/resources/system_group.rb', line 75

def remove_systems(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) —

    id of the system group

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

#systems(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) —

    id of the system group

  • organization_id (String) —

    organization identifier

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



49
50
51
 
# File 'lib/katello_api/resources/system_group.rb', line 49

def systems(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 (String) —

    id of the system group

  • organization_id (String) —

    organization identifier

  • system_group (Hash) —

    allowed keys are:

    • description [String, nil]

    • max_systems [Numeric, nil] maximum number of systems in the group

    • name [String] system group name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



39
40
41
 
# File 'lib/katello_api/resources/system_group.rb', line 39

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