community.general.ipmi_power – Power management for machine
Note
This plugin is part of the community.general collection (version 3.8.3).
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 community.general
.
To use it in a playbook, specify: community.general.ipmi_power
.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
pyghmi
Parameters
Parameter |
Comments |
---|---|
Hostname or ip address of the BMC. |
|
Password to connect to the BMC. |
|
Remote RMCP port. Default: 623 |
|
Whether to ensure that the machine in desired state. The choices for state are: - on – Request system turn on - off – Request system turn off without waiting for OS to shutdown - shutdown – Have system request OS proper shutdown - reset – Request system reset without waiting for OS - boot – If system is off, then ‘on’, else ‘reset’ Choices:
|
|
Maximum number of seconds before interrupt request. Default: 300 |
|
Username to use to connect to the BMC. |
Examples
- name: Ensure machine is powered on
community.general.ipmi_power:
name: test.testdomain.com
user: admin
password: password
state: on
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The current power state of the machine. Returned: success Sample: true |
Authors
Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>