The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| name - / required | Hostname or ip address of the BMC. | |
| password - / required | Password to connect to the BMC. | |
| port - | Default: 623 | Remote RMCP port. |
| state - / required |
| Whether to ensure that the machine in desired state. |
| timeout - | Default: 300 | Maximum number of seconds before interrupt request. |
| user - / required | Username to use to connect to the BMC. |
# Ensure machine is powered on.
- ipmi_power:
name: test.testdomain.com
user: admin
password: password
state: on
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| powerstate string | success | The current power state of the machine. Sample: True |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ipmi_power_module.html