Documentation

ipmi_boot - Management of order of boot devices

New in version 2.2.

Synopsis

  • Use this module to manage order of boot devices

Options

parameter required default choices comments
bootdev
yes
  • network -- Request network boot
  • 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
Set boot device to use on next reboot
name
yes
Hostname or ip address of the BMC.
password
yes
Password to connect to the BMC.
persistent
no
  • yes
  • no
If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this.
port
no 623
Remote RMCP port.
state
no present
  • present -- Request system turn on
  • absent -- Request system turn on
Whether to ensure that boot devices is desired.
uefiboot
no
  • yes
  • no
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.
user
yes
Username to use to connect to the BMC.

Examples

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

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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

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


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.