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

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Use this module to manage order of boot devices

Requirements

• python >= 2.6
• pyghmi

Usage examples

Scanned by Steampunk Spotter

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

# Ensure bootdevice is HD.
- ipmi_boot:
    name: test.testdomain.com
    user: admin
    password: password
    bootdev: hd

Scanned by Steampunk Spotter

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

# Ensure bootdevice is not Network
- ipmi_boot:
    name: test.testdomain.com
    user: admin
    password: password
    bootdev: network
    state: absent

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:
    - present -- Request system turn on
    - absent -- Request system turn on
    default: present
    description:
    - Whether to ensure that boot devices is desired.

bootdev:
    choices:
    - network -- Request network boot
    - floppy -- Boot from floppy
    - hd -- Boot from hard drive
    - safe -- Boot from hard drive, requesting 'safe mode'
    - optical -- boot from CD/DVD/BD drive
    - setup -- Boot into setup utility
    - default -- remove any IPMI directed boot device request
    description:
    - Set boot device to use on next reboot
    required: true

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

uefiboot:
    default: 'no'
    description:
    - If set, request UEFI boot explicitly. Strictly speaking, the spec suggests that
      if not set, the system should BIOS boot and offers no "don't care" option. In practice,
      this flag not being set does not preclude UEFI boot on any system I've encountered.
    type: bool

persistent:
    default: 'no'
    description:
    - If set, ask that system firmware uses this device beyond next boot. Be aware many
      systems do not honor this.
    type: bool

Outputs

bootdev:
  description: The boot device name which will be used beyond next boot.
  returned: success
  sample: default
  type: str
persistent:
  description: If True, system firmware will use this device beyond next boot.
  returned: success
  sample: false
  type: bool
uefimode:
  description: If True, system firmware will use UEFI boot explicitly beyond next
    boot.
  returned: success
  sample: false
  type: bool