redhat.satellite.realm – Manage Realms

Note

This plugin is part of the redhat.satellite collection (version 3.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install redhat.satellite.

To use it in a playbook, specify: redhat.satellite.realm.

New in version 1.0.0: of redhat.satellite

Synopsis

• Manage Realms

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Comments
locations list / elements=string	List of locations the entity should be assigned to
name string / required	Name of the realm
organizations list / elements=string	List of organizations the entity should be assigned to
password string / required	Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable SATELLITE_PASSWORD will be used instead.
realm_proxy string / required	Proxy to use for this realm
realm_type string / required	Realm type Choices: Red Hat Identity Management FreeIPA Active Directory
server_url string / required	URL of the Foreman server. If the value is not specified in the task, the value of environment variable SATELLITE_SERVER_URL will be used instead.
state string	State of the entity Choices: present ← (default) absent
username string / required	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable SATELLITE_USERNAME will be used instead.
validate_certs boolean	Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable SATELLITE_VALIDATE_CERTS will be used instead. Choices: no yes ← (default)

Examples

- name: "Create EXAMPLE.LOCAL Realm"
  redhat.satellite.realm:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "EXAMPLE.COM"
    realm_proxy: "satellite.example.com"
    realm_type: "Red Hat Identity Management"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
realms list / elements=dictionary	List of realms. Returned: success

Authors

• Lester R Claudio (@claudiol1)