community.general.ipmi_power (2.5.9) — module

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9

Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

Use this module for power management

Requirements

• python >= 2.6
• pyghmi

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

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

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

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

state:
    choices:
    - 'on'
    - 'off'
    - shutdown
    - reset
    - boot
    description:
    - 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'''
    required: true
    type: str

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

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

Outputs

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