community.general.ipmi_power – Power management for machine

Note

This plugin is part of the community.general collection (version 3.8.1).

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.

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
integer
Default:
623
Remote RMCP port.
state
string / required
    Choices:
  • on
  • off
  • shutdown
  • reset
  • boot
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
integer
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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipmi_power_module.html