redhat.satellite.status_info module – Get status info

Note

This module is part of the redhat.satellite collection (version 3.10.0).

To install it, use: ansible-galaxy collection install redhat.satellite. You need further requirements to be able to use this module, see Requirements for details.

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

New in redhat.satellite 1.3.0

Synopsis

  • Get status information from the server

Requirements

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

  • requests

Parameters

Parameter

Comments

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.

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.

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:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: status
  redhat.satellite.status_info:
    server_url: "https://satellite.example.com"
    username: "admin"
    password: "changeme"

Return Values

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

Key

Description

ping

dictionary

Detailed service status.

Returned: if supported by server

status

dictionary

Basic status of the server.

Returned: always

Authors

  • Evgeni Golov (@evgeni)