Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 1. Introduction to Satellite Ansible Collection

Satellite Ansible Collection provides a set of Ansible modules for managing Satellite. Using the modules, you can automate many aspects of Satellite management.

1.1. Installing the Satellite Ansible modules
Copy link

Modules from the Satellite Ansible Collection are provided by the ansible-collection-redhat-satellite package. On your Satellite Server, the package is installed by default. If you want to execute your playbooks on a different system, you must first install the package that provides them.

Note

You can execute your playbooks on any system that can reach the Satellite API. This can also be your Satellite Server itself.

Procedure

  • Install the ansible-collection-redhat-satellite package: 

    # dnf install ansible-collection-redhat-satellite
    Copy to Clipboard Toggle word wrap

Verification

  • Display the list of Ansible modules that are now available on your system: 

    # ansible-doc --list redhat.satellite
    Copy to Clipboard Toggle word wrap

Next steps

  • You can now use the installed Ansible modules to execute playbooks.
Note

To view the built-in documentation, Satellite Ansible Collection must be installed on your system. For more information, see Section 1.1, “Installing the Satellite Ansible modules”.

You can view the full built-in documentation for available modules with the following command: 

# ansible-doc --list redhat.satellite
Copy to Clipboard Toggle word wrap

You can view the built-in documentation for a particular module with the following command: 

# ansible-doc redhat.satellite.Module_Name
Copy to Clipboard Toggle word wrap

For example: 

# ansible-doc redhat.satellite.location
Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

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

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.

Theme

© 2025 Red Hat