community.general.ipmi_boot – Management of order of boot devices

From Get docs
Ansible/docs/2.11/collections/community/general/ipmi boot module


community.general.ipmi_boot – Management of order of boot devices

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ipmi_boot.


Synopsis

  • Use this module to manage order of boot devices

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • pyghmi

Parameters

Parameter Choices/Defaults Comments

bootdev

string / required

  • network
  • floppy
  • hd
  • safe
  • optical
  • setup
  • default

Set boot device to use on next reboot

The choices for the device are: - 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

name

string / required

Hostname or ip address of the BMC.

password

string / required

Password to connect to the BMC.

persistent

boolean

  • no

  • yes

If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this.

port

string

Default:

623

Remote RMCP port.

state

string

  • present

  • absent

Whether to ensure that boot devices is desired.

The choices for the state are: - present -- Request system turn on - absent -- Request system turn on

uefiboot

boolean

  • no

  • yes

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

string / required

Username to use to connect to the BMC.



Examples

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

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

Return Values

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

Key Returned Description

bootdev

string

success

The boot device name which will be used beyond next boot.


Sample:

default

persistent

boolean

success

If True, system firmware will use this device beyond next boot.


uefimode

boolean

success

If True, system firmware will use UEFI boot explicitly beyond next boot.





Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ipmi_boot_module.html