Class: KatelloApi::Resources::SystemsBulkAction

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

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

Instance Method Details

- (Array) applicable_errata(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):

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



51
52
53
 
# File 'lib/katello_api/resources/systems_bulk_action.rb', line 51

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

- (Array) bulk_add_system_groups(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):

  • system_group_ids (Array) —

    list of system group ids

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



20
21
22
 
# File 'lib/katello_api/resources/systems_bulk_action.rb', line 20

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

- (Array) bulk_remove_system_groups(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):

  • system_group_ids (Array) —

    list of system group ids

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



36
37
38
 
# File 'lib/katello_api/resources/systems_bulk_action.rb', line 36

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

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



117
118
119
 
# File 'lib/katello_api/resources/systems_bulk_action.rb', line 117

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

- (Array) environment_content_view(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):

  • content_view_id (Numeric)
  • environment_id (Numeric)
  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

- (Array) install_content(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):

  • content (Array) —

    list of content (e.g. package names, package group names or errata ids)

  • content_type (String) —

    the type of content. the following types are supported: ‘package’, ‘package_group’ and ‘errata’.

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



68
69
70
 
# File 'lib/katello_api/resources/systems_bulk_action.rb', line 68

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

- (Array) remove_content(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):

  • content (Array) —

    list of content (e.g. package or package group names)

  • content_type (String) —

    the type of content. the following types are supported: ‘package’ and ‘package_group.

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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

- (Array) update_content(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):

  • content (Array) —

    list of content (e.g. package or package group names)

  • content_type (String) —

    the type of content. the following types are supported: ‘package’ and ‘package_group.

  • exclude (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to exclude and not run an action on

  • include (Hash) —

    allowed keys are:

    • ids [Array, nil] list of system ids to perform an action on

    • search [String, nil] search string for systems to perform an action on

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



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

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