airgun.entities.hostcollection

Module Contents

class airgun.entities.hostcollection.HostCollectionEntity

Bases: airgun.entities.base.BaseEntity

endpoint_path = /host_collections
create(self, values)

Create a host collection

delete(self, entity_name)

Delete the host collection entity.

search(self, value)

Search for ‘value’ and return host collections that match.

read(self, entity_name, widget_names=None)

Return a dict with properties of host collection.

update(self, entity_name, values)

Update host collection properties with values.

associate_host(self, entity_name, host_name)

Associate a host with host collection

Parameters:
  • entity_name (str) – The host collection name.
  • host_name (str) – The host name to be associated with to host collection name.
manage_packages(self, entity_name, content_type='Package', packages=None, action='install', action_via='via Katello Agent', job_values=None)

Manage host collection packages.

Parameters:
  • entity_name (str) – The host collection name.
  • content_type (str) – The content type to apply action on. Available options: Package, Package Group.
  • packages (str) – a list of packages separated by a space to apply the action on.
  • action (str) – The action to apply. Available options: install, update, update_all, delete.
  • action_via (str) – Via which mean to apply action. Available options: “via Katello Agent”, “via remote execution”, “via remote execution - customize first”
  • job_values (dict) – Remote Execution Job custom form values. When action_via is: “via remote execution - customize first”, the new remote execution job form is opened and we can set custom values.
install_errata(self, entity_name, errata_id, install_via='via Katello agent', job_values=None)

Install host collection errata

Parameters:
  • entity_name (str) – The host collection name.
  • errata_id (str) – the errata id to install.
  • install_via (str) – Via which mean to install errata. Available options: “via Katello Agent”, “via remote execution”, “via remote execution - customize first”
  • job_values (dict) – Remote Execution Job custom form values. When install_via is: “via remote execution - customize first”, the new remote execution job form is opened and we can set custom values.
Returns:

Task details view values when install “via kattelo agent” else returns job status view values.
manage_module_streams(self, entity_name, action_type, module_name, stream_version, customize=False, customize_values=None)

Manage module streams :param str entity_name: The host collection name. :param action_type: remote action to execute on content host. Action value can be one of them e.g. ‘Enable’, ‘Disable’, ‘Install’, ‘Update’, ‘Remove’, ‘Reset’

Parameters:
  • module_name (str) – Module Stream name to remotely install/upgrade/remove (depending on action_type)
  • stream_version (str) – String with Stream Version of Module
  • customize – Boolean indicating if additional custom action should be called
  • customize_values – Dict with custom actions to run. Mandatory if customize is True
Returns:

Returns a dict containing job status details
change_assigned_content(self, entity_name, lce, content_view)

Change host collection lifecycle environment and content view

Parameters:
  • entity_name (str) – The host collection name.
  • lce (str) – Lifecycle environment name.
  • content_view (str) – Content view name.
Returns:

task details view values
class airgun.entities.hostcollection.ShowAllHostCollections

Bases: airgun.navigation.NavigateStep

VIEW
step(self, *args, **kwargs)
class airgun.entities.hostcollection.AddNewHostCollections

Bases: airgun.navigation.NavigateStep

VIEW
prerequisite
step(self, *args, **kwargs)
class airgun.entities.hostcollection.EditHostCollections

Bases: airgun.navigation.NavigateStep

VIEW
prerequisite(self, *args, **kwargs)
step(self, *args, **kwargs)