community.general.ipmi_boot (8.5.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Use this module to manage order of boot devices

Requirements

• pyghmi

Usage examples

Scanned by Steampunk Spotter

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

- name: Ensure bootdevice is HD
  community.general.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.

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

Inputs

    
key:
    description:
    - Encryption key to connect to the BMC in hex format.
    required: false
    type: str
    version_added: 4.1.0
    version_added_collection: community.general

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:
    - present
    - absent
    default: present
    description:
    - Whether to ensure that boot devices is desired.
    - 'The choices for the state are: - present -- Request system turn on - absent --
      Request system turn on'
    type: str

bootdev:
    choices:
    - network
    - floppy
    - hd
    - safe
    - optical
    - setup
    - default
    description:
    - 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'
    required: true
    type: str

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

uefiboot:
    default: false
    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: false
    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