Documentation

vmware_guest_boot_facts – Gather facts about boot options for the given virtual machine

New in version 2.7.

Synopsis

  • This module can be used to gather facts aboyt 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
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 version 2.6.
name
-
Name of the VM to work with.
This is required if uuid parameter is not supplied.
name_match
-
    Choices:
  • 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 version 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 version 2.6.
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 version 2.6.

aliases: admin, user
uuid
-
UUID of the instance to manage if known, this is VMware's BIOS UUID.
This is required if name parameter is not supplied.
validate_certs
boolean
    Choices:
  • 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 version 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: Gather facts about virtual machine's boot order and related parameters
  vmware_guest_boot_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    name: "{{ vm_name }}"
  register: vm_boot_order_facts

Return Values

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

Key Returned Description
vm_boot_facts
dictionary
always
metadata about boot order of virtual machine

Sample:
{'current_boot_retry_enabled': True, 'current_boot_delay': 2000, 'current_boot_order': ['floppy', 'disk', 'ethernet', 'cdrom'], 'current_enter_bios_setup': True, 'current_boot_retry_delay': 22300, 'current_boot_firmware': 'bios'}


Status

Authors

Hint

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