theforeman.foreman.status_info – Get status info

Note

This plugin is part of the theforeman.foreman collection (version 1.5.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.status_info.

New in version 1.3.0: of theforeman.foreman

Synopsis

  • Get status information from the server

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults 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 FOREMAN_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 FOREMAN_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 FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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 FOREMAN_VALIDATE_CERTS will be used instead.

Examples

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

Return Values

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

Key Returned Description
ping
dictionary
if supported by server
Detailed service status.
status
dictionary
always
Basic status of the server.


Authors

  • Evgeni Golov (@evgeni)