theforeman.foreman.host_power – Manage Power State of Hosts¶
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.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.
Parameters¶
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 | Returned | Description |
---|---|---|
power_state
string
|
always |
current power state of host
Sample:
off
|
Authors¶
Bernhard Hopfenmueller (@Fobhep) ATIX AG
Baptiste Agasse (@bagasse)