vmware_guest_boot_manager – Manage boot options for the given virtual machine

From Get docs
Ansible/docs/2.8/modules/vmware guest boot manager module


vmware_guest_boot_manager – Manage boot options for the given virtual machine

New in version 2.7.


Synopsis

  • This module can be used to manage boot options for the given virtual machine.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments

boot_delay

-

Default:

0

Delay in milliseconds before starting the boot sequence.

boot_firmware

-

  • bios
  • efi

Choose which firmware should be used to boot the virtual machine.

boot_order

-

Default:

[]

List of the boot devices.

boot_retry_delay

-

Default:

0

Specify the time in milliseconds between virtual machine boot failure and subsequent attempt to boot again.

If set, will automatically set boot_retry_enabled to True as this parameter is required.

boot_retry_enabled

boolean

  • no

  • yes

If set to True, the virtual machine that fails to boot, will try to boot again after boot_retry_delay is expired.

If set to False, the virtual machine waits indefinitely for user intervention.

enter_bios_setup

boolean

  • no

  • yes

If set to True, the virtual machine automatically enters BIOS setup the next time it boots.

The virtual machine resets this flag, so that the machine boots proceeds normally.

hostname

string

The hostname or IP address of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

Environment variable support added in Ansible 2.6.

name

-

Name of the VM to work with.

This is required if uuid parameter is not supplied.

name_match

-

  • first

  • last

If multiple virtual machines matching the name, use the first or last found.

password

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

Environment variable support added in Ansible 2.6.


aliases: pass, pwd

port

integer

added in 2.5

Default:

443

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Environment variable support added in Ansible 2.6.

secure_boot_enabled

boolean

added in 2.8

  • no

  • yes

Choose if EFI secure boot should be enabled. EFI secure boot can only be enabled with boot_firmware = efi

use_instance_uuid

boolean

added in 2.8

  • no

  • yes

Whether to use the VMWare instance UUID rather than the BIOS UUID.

username

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

Environment variable support added in Ansible 2.6.


aliases: admin, user

uuid

-

UUID of the instance to manage if known, this is VMware's BIOS UUID by default.

This is required if name parameter is not supplied.

validate_certs

boolean

  • no
  • yes

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Environment variable support added in Ansible 2.6.

If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.



Notes

Note

  • Tested on vSphere 6.5


Examples

- name: Change virtual machine's boot order and related parameters
  vmware_guest_boot_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: testvm
    boot_delay: 2000
    enter_bios_setup: True
    boot_retry_enabled: True
    boot_retry_delay: 22300
    boot_firmware: bios
    secure_boot_enabled: False
    boot_order:
      - floppy
      - cdrom
      - ethernet
      - disk
  delegate_to: localhost
  register: vm_boot_order

Return Values

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

Key Returned Description

vm_boot_status

dictionary

always

metadata about boot order of virtual machine


Sample:

{'current_boot_order': ['floppy', 'disk', 'ethernet', 'cdrom'], 'current_boot_delay': 2000, 'current_boot_retry_delay': 22300, 'current_boot_retry_enabled': True, 'current_enter_bios_setup': True, 'current_boot_firmware': 'bios', 'current_secure_boot_enabled': False, 'previous_boot_delay': 10, 'previous_boot_retry_delay': 10000, 'previous_boot_retry_enabled': True, 'previous_enter_bios_setup': False, 'previous_boot_firmware': 'efi', 'previous_secure_boot_enabled': True, 'previous_boot_order': ['ethernet', 'cdrom', 'floppy', 'disk']}




Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vmware_guest_boot_manager_module.html