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_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



77
78
79
 
# File 'lib/katello_api/resources/system_group.rb', line 77

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



116
117
118
 
# File 'lib/katello_api/resources/system_group.rb', line 116

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



45
46
47
 
# File 'lib/katello_api/resources/system_group.rb', line 45

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



125
126
127
 
# File 'lib/katello_api/resources/system_group.rb', line 125

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



134
135
136
 
# File 'lib/katello_api/resources/system_group.rb', line 134

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



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

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



106
107
108
 
# File 'lib/katello_api/resources/system_group.rb', line 106

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

  • organization_id (String) —

    organization 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



32
33
34
 
# File 'lib/katello_api/resources/system_group.rb', line 32

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



87
88
89
 
# File 'lib/katello_api/resources/system_group.rb', line 87

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



67
68
69
 
# File 'lib/katello_api/resources/system_group.rb', line 67

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



58
59
60
 
# File 'lib/katello_api/resources/system_group.rb', line 58

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