vmware.vmware_rest.vcenter_vm_hardware_boot_device_info module – Gather information about the boot device order of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_boot_device_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Return the ordered list of devices that a virtual machine attempts to boot from.

  • The order of the returned entries reflects the sequence in which the virtual machine tries each device during boot.

  • Each entry identifies a device class (such as CD-ROM or floppy) or specific bootable devices such as virtual disks or an Ethernet adapter.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

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

vcenter_password

string / required

The vSphere vCenter password.

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

vcenter_port

integer

The port number of the vSphere vCenter.

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

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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

vcenter_username

string / required

The vSphere vCenter username.

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

vcenter_validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

vm

string / required

Identifier of the virtual machine whose boot device order should be queried.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Look up the virtual machine by name
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
      - test_vm1

- name: Gather the boot device order of a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_boot_device_info:
    vm: '{{ search_result.value[0].vm }}'
  register: boot_device_order

Return Values

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

Key

Description

info

list / elements=string

An ordered list of the devices the virtual machine attempts to boot from.

Returned: On success.

Sample: [{"type": "CDROM"}, {"disks": ["16000"], "type": "DISK"}, {"nic": "4000", "type": "ETHERNET"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success.

Sample: [{"type": "CDROM"}, {"disks": ["16000"], "type": "DISK"}, {"nic": "4000", "type": "ETHERNET"}]

Authors

  • Ansible Eco Content Team (@eco-ansible-content)