Chapter 4. Managing Satellite with Ansible Collections

Satellite Ansible Collections is a set of Ansible modules that interact with the Satellite API. You can use Satellite Ansible Collections to manage and automate many aspects of Satellite.

4.1. Installing the Satellite Ansible Modules from RPM

Use this procedure to install the Satellite Ansible modules.

Prerequisite

  • Ensure that the Ansible 2.9 or later repository is enabled and the ansible package is updated:

    # subscription-manager repos --enable rhel-7-server-ansible-2.9-rpms
    # satellite-maintain packages update ansible

Procedure

  • Install the RPM using the following command:

    # satellite-maintain packages install ansible-collection-redhat-satellite

4.2. Viewing the Satellite Ansible Modules

You can view the installed Satellite Ansible modules by listing the content of the following directory:

# ls /usr/share/ansible/collections/ansible_collections/redhat/satellite/plugins/modules/
Note

At the time of writing, the ansible-doc -l command does not list collections yet.

Alternatively, you can also see the complete list of Satellite Ansible modules and other related information at https://cloud.redhat.com/ansible/automation-hub/redhat/satellite/docs.

All modules are in the `redhat.satellite` namespace and can be referred to in the format `redhat.satellite._module_name_`. For example, to display information about the activation_key module, enter the following command:

$ ansible-doc redhat.satellite.activation_key