redhat.satellite.host_power module – Manage Power State of Hosts

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in redhat.satellite 1.0.0

Synopsis

  • Manage power state of a host

  • This beta version can start and stop an existing foreman host and question the current power state.

Aliases: foreman_host_power

Requirements

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

  • requests

Parameters

Parameter

Comments

name

aliases: hostname

string / required

Name (FQDN) of the host

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.

state

string

Desired power state

Choices:

  • "on"

  • "start"

  • "off"

  • "stop"

  • "soft"

  • "reboot"

  • "cycle"

  • "reset"

  • "state" ← (default)

  • "status"

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: "Switch a host on"
  redhat.satellite.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    hostname: "test-host.domain.test"
    state: 'on'

- name: "Switch a host off"
  redhat.satellite.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    hostname: "test-host.domain.test"
    state: 'off'

- name: "Query host power state"
  redhat.satellite.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    hostname: "test-host.domain.test"
    state: state
    register: result
- debug:
    msg: "Host power state is {{ result.power_state }}"

Return Values

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

Key

Description

power_state

string

current power state of host

Returned: always

Sample: "off"

Authors

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Baptiste Agasse (@bagasse)