Chapter 4. Managing Satellite with Ansible Collections

download PDF

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

Use this procedure to install the Satellite Ansible modules.


  • Install the package 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 running:

# ansible-doc -l redhat.satellite

Alternatively, you can also see the complete list of Satellite Ansible modules and other related information at Red Hat Ansible Automation Platform.

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
Red Hat logoGithubRedditYoutubeTwitter


Try, buy, & sell


About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.