Class: KatelloApi::Resources::SystemGroup

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

Constant Summary

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

+ (Object) doc



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

- (Array) add_activation_keys(params = {}, headers = {})

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

  • activation_key_ids (Array)

    array of activation key ids

Returns:

  • (Array)

    First item: parsed data; second item: raw body



99
100
101
# File 'lib/katello_api/resources/system_group.rb', line 99

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

- (Array) add_systems(params = {}, headers = {})

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

  • system_ids (Array)

    array of system ids

Returns:

  • (Array)

    First item: parsed data; second item: raw body



79
80
81
# File 'lib/katello_api/resources/system_group.rb', line 79

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

- (Array) copy(params = {}, headers = {})

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

  • name (String)

    new system group name

Returns:

  • (Array)

    First item: parsed data; second item: raw body



156
157
158
# File 'lib/katello_api/resources/system_group.rb', line 156

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

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

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_ids (Array)

    list of system uuids to be in the group

  • description (String)
  • max_systems (Numeric)

    maximum number of systems in the group

  • name (String)

    system group name

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

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

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



137
138
139
# File 'lib/katello_api/resources/system_group.rb', line 137

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

- (Array) destroy_systems(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



146
147
148
# File 'lib/katello_api/resources/system_group.rb', line 146

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

- (Array) history(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



118
119
120
# File 'lib/katello_api/resources/system_group.rb', line 118

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

- (Array) history_show(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



128
129
130
# File 'lib/katello_api/resources/system_group.rb', line 128

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

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

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

  • activation_key_id (String)

    activation key identifier

  • organization_id (String)

    organization identifier

  • system_id (String)

    system identifier

  • full_results (String)

    whether or not to show all results

  • name (String)

    system group name to filter by

  • order (String)

    sort field and order, eg. ‘name desc’

  • page (String)

    page number, starting at 1

  • per_page (String)

    number of results per page to return

  • search (String)

    search string

  • sort (Hash)

    hash version of ‘order’ param allowed keys are:

    • by [String] field to sort the results on

    • order [String] how to order the sorted results (e.g. asc for ascending)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



34
35
36
# File 'lib/katello_api/resources/system_group.rb', line 34

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

- (Array) remove_activation_keys(params = {}, headers = {})

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 activation key group

  • activation_key_ids (Array)

    array of activation key ids

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) remove_systems(params = {}, headers = {})

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

  • system_ids (Array)

    array of system ids

Returns:

  • (Array)

    First item: parsed data; second item: raw body



89
90
91
# File 'lib/katello_api/resources/system_group.rb', line 89

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

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

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



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

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

- (Array) systems(params = {}, headers = {})

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

Returns:

  • (Array)

    First item: parsed data; second item: raw body



69
70
71
# File 'lib/katello_api/resources/system_group.rb', line 69

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

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

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

  • system_ids (Array)

    list of system uuids to be in the group

  • description (String)
  • max_systems (Numeric)

    maximum number of systems in the group

  • name (String)

    system group name

Returns:

  • (Array)

    First item: parsed data; second item: raw body



60
61
62
# File 'lib/katello_api/resources/system_group.rb', line 60

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