community.general.hpilo_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

This module boots a system through its HP iLO interface. The boot media can be one of: cdrom, floppy, hdd, network or usb.

This module requires the hpilo python module.

Requirements

• python-hpilo

Usage examples

Scanned by Steampunk Spotter

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

- name: Task to boot a system using an ISO from an HP iLO interface only if the system is an HP server
  community.general.hpilo_boot:
    host: YOUR_ILO_ADDRESS
    login: YOUR_ILO_LOGIN
    password: YOUR_ILO_PASSWORD
    media: cdrom
    image: http://some-web-server/iso/boot.iso
  when: cmdb_hwmodel.startswith('HP ')
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Power off a server
  community.general.hpilo_boot:
    host: YOUR_ILO_HOST
    login: YOUR_ILO_LOGIN
    password: YOUR_ILO_PASSWORD
    state: poweroff
  delegate_to: localhost

Inputs

    
host:
    description:
    - The HP iLO hostname/address that is linked to the physical system.
    required: true
    type: str

force:
    default: false
    description:
    - Whether to force a reboot (even when the system is already booted).
    - As a safeguard, without force, hpilo_boot will refuse to reboot a server that is
      already running.
    type: bool

image:
    description:
    - The URL of a cdrom, floppy or usb boot media image. protocol://username:password@hostname:port/filename
    - protocol is either 'http' or 'https'
    - username:password is optional
    - port is optional
    type: str

login:
    default: Administrator
    description:
    - The login name to authenticate to the HP iLO interface.
    type: str

media:
    choices:
    - cdrom
    - floppy
    - rbsu
    - hdd
    - network
    - normal
    - usb
    description:
    - The boot media to boot the system from
    type: str

state:
    choices:
    - boot_always
    - boot_once
    - connect
    - disconnect
    - no_boot
    - poweroff
    default: boot_once
    description:
    - The state of the boot media.
    - 'no_boot: Do not boot from the device'
    - 'boot_once: Boot from the device once and then notthereafter'
    - 'boot_always: Boot from the device each time the server is rebooted'
    - 'connect: Connect the virtual media device and set to boot_always'
    - 'disconnect: Disconnects the virtual media device and set to no_boot'
    - 'poweroff: Power off the server'
    type: str

password:
    default: admin
    description:
    - The password to authenticate to the HP iLO interface.
    type: str

ssl_version:
    choices:
    - SSLv3
    - SSLv23
    - TLSv1
    - TLSv1_1
    - TLSv1_2
    default: TLSv1
    description:
    - Change the ssl_version used.
    type: str