foreman_host_power – Manage Foreman hosts power state¶
Synopsis¶
Manage power state of Foreman host
This beta version can start and stop an existing foreman host and question the current power state.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
name
string
/ required
|
Name (FQDN) of the host
aliases: hostname |
|
password
string
/ required
|
Password of the user accessing the Foreman server
|
|
server_url
string
/ required
|
URL of the Foreman server
|
|
state
string
|
|
Desired power state
|
username
string
/ required
|
Username accessing the Foreman server
|
|
validate_certs
boolean
|
|
Whether or not to verify the TLS certificates of the Foreman server
aliases: verify_ssl |
Examples¶
- name: "Switch a host on"
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"
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"
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
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Bernhard Hopfenmueller (@Fobhep) ATIX AG
Baptiste Agasse (@bagasse)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.