Docs4dev
Docs
ansible / 2.4 / ipmi_power_module.html

ipmi_power - Power management for machine

New in version 2.2.

Synopsis

  • Use this module for power management

Requirements (on host that executes module)

  • python >= 2.6
  • pyghmi

Options

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
  • 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'
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.

Examples

# Ensure machine is powered on.
- ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: on

Return Values

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

Status

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.

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