You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sets the virtual devices that will be used to boot the virtual machine
Version added: 0.1.0
Synopsis
Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except ETHERNET in the list.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter
Choices/Defaults
Comments
devices
list
/ elements=dictionary
/ required
Ordered list of boot devices. This parameter is mandatory.
Valid attributes are:
- type (str): This option defines the valid device types that may be used as bootable devices. (['set'])
This key is required with ['set'].
- Accepted values:
- CDROM
- DISK
- ETHERNET
- FLOPPY
- nic (str): Virtual Ethernet device. Ethernet device to use as boot device for this entry.
This field is optional and it is only relevant when the value of type is ETHERNET.
When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_ethernet. (['set'])
- disks (list): Virtual disk device. List of virtual disks in boot order.
This field is optional and it is only relevant when the value of type is DISK.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_vm_hardware_disk. (['set'])
session_timeout
float
added in 2.1.0
Timeout settings for client session.
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
The default value is 300s.
state
string
Choices:
set ←
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_rest_log_file
string
You can use this optional parameter to set the location of a log file.
This file will be used to record the HTTP REST interaction.
The file will be stored on the host that run the module.
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
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.
vm
string
/ required
Virtual machine identifier.
The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory.
Notes
Note
- Tested on vSphere 7.0.3
Examples
- name: Look up the VM called test_vm1 in the inventoryregister: search_resultvmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VMvmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'register: test_vm1_info
- name: Set a boot devicevmware.vmware_rest.vcenter_vm_hardware_boot_device:
vm: '{{ test_vm1_info.id }}'devices:
- type: CDROMregister: _result
Return Values
Common return values are documented here, the following are the fields unique to this module: