community.general.ipmi_power – Power management for machine
community.general.ipmi_power – Power management for machine
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ipmi_power
.
Synopsis
- Use this module for power management
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- pyghmi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name string / required |
Hostname or ip address of the BMC. | |
password string / required |
Password to connect to the BMC. | |
port string |
Default: 623 |
Remote RMCP port. |
state string / required |
|
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' |
timeout string |
Default: 300 |
Maximum number of seconds before interrupt request. |
user string / required |
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 | Returned | Description |
---|---|---|
powerstate string |
success |
The current power state of the machine.
Sample: True |
Authors
- Bulat Gaifullin (@bgaifullin) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ipmi_power_module.html