theforeman.foreman.host_power – Manage Power State of Hosts

Note

This plugin is part of the theforeman.foreman collection (version 2.2.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 theforeman.foreman.

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

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Manage power state of a host

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

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 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.

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 FOREMAN_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 FOREMAN_VALIDATE_CERTS will be used instead.

Choices:

  • no

  • yes ← (default)

Examples

- name: "Switch a host on"
  theforeman.foreman.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    hostname: "test-host.domain.test"
    state: on

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

- name: "Query host power state"
  theforeman.foreman.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.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)