ansible.builtin.ipmi_power (v2.9.27) — module

Power management for machine

| "added in version" 2.2 of ansible.builtin"

Authors: Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Use this module for power management


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Ensure machine is powered on.
- ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: on

Inputs

    
name:
    description:
    - Hostname or ip address of the BMC.
    required: true

port:
    default: 623
    description:
    - Remote RMCP port.

user:
    description:
    - Username to use to connect to the BMC.
    required: true

state:
    choices:
    - 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'
    description:
    - Whether to ensure that the machine in desired state.
    required: true

timeout:
    default: 300
    description:
    - Maximum number of seconds before interrupt request.

password:
    description:
    - Password to connect to the BMC.
    required: true

Outputs

powerstate:
  description: The current power state of the machine.
  returned: success
  sample: true
  type: str