New in version 2.2.
- python >= 2.6
- pyghmi
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| name |
yes |
Hostname or ip address of the BMC.
|
||
| password |
yes |
Password to connect to the BMC.
|
||
| port |
no | 623 |
Remote RMCP port.
|
|
| state |
yes |
|
Whether to ensure that the machine in desired state.
|
|
| timeout |
no | 300 |
Maximum number of seconds before interrupt request.
|
|
| user |
yes |
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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| powerstate |
The current power state of the machine.
|
success | string | True |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.