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

Note

This plugin is part of the community.vmware collection (version 1.7.0).

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

To use it in a playbook, specify: community.vmware.vmware_guest_boot_facts.

DEPRECATED

Removed in

major release after 2021-12-01

Why

Deprecated in favour of community.vmware.vmware_guest_boot_info module.

Alternative

Use community.vmware.vmware_guest_boot_info instead.

Synopsis

  • Gather facts about 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 Ansible 2.6.
moid
string
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance.
This is required if name or uuid is not supplied.
name
string
Name of the VM to work with.
This is required if uuid or moid parameter is not supplied.
name_match
string
    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 Ansible 2.6.

aliases: pass, pwd
port
integer
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.
proxy_host
string
Address of a proxy that will receive all HTTPS requests and relay them.
The format is a hostname or a IP.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port
integer
Port of the HTTP proxy that will receive all HTTPS requests and relay them.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.
use_instance_uuid
boolean
    Choices:
  • 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
string
UUID of the instance to manage if known, this is VMware's BIOS UUID by default.
This is required if name or moid 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 Ansible 2.6.
If set to true, 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
  community.vmware.vmware_guest_boot_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "{{ vm_name }}"
  register: vm_boot_order_facts

- name: Gather facts about virtual machine's boot order using MoID
  community.vmware.vmware_guest_boot_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: "vm-42"
  register: vm_moid_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_delay': 2000, 'current_boot_firmware': 'bios', 'current_boot_order': ['floppy', 'disk', 'ethernet', 'cdrom'], 'current_boot_retry_delay': 22300, 'current_boot_retry_enabled': True, 'current_enter_bios_setup': True, 'current_secure_boot_enabled': False}


Status

  • This module will be removed in a major release after 2021-12-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Abhijeet Kasurde (@Akasurde)