vcenter_vm_hardware_boot
Updates the boot-related settings of a virtual machine
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_vm_hardware_boot
Synopsis
Updates the boot-related settings of a virtual machine
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) 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 runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | 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. | ||||
| delay | int | Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. | ||
| If unset, the value is unchanged. | ||||
| efi_legacy_boot | bool | Flag indicating whether to use EFI legacy boot mode. | ||
| If unset, the value is unchanged. | ||||
| enter_setup_mode | bool | Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. | ||
| If unset, the value is unchanged. | ||||
| network_protocol | string | The I(network_protocol) enumerated type defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. | ||
| retry | bool | Flag indicating whether the virtual machine should automatically retry the boot process after a failure. | ||
| If unset, the value is unchanged. | ||||
| retry_delay | int | Delay in milliseconds before retrying the boot process after a failure; applicable only when I(retry) is true. | ||
| If unset, the value is unchanged. | ||||
| state | string | present | Operation to perform; allowed values: present. | |
| type | string | The I(type) enumerated type defines the valid firmware types for a virtual machine. | ||
| vm | string | yes | Virtual machine identifier. | |
| The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory. |
Example
yaml
- name: Look up the VM called test_vm1 in the inventory
register: search_result
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VM
vmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'
register: test_vm1_info
- name: Change a VM boot parameters
vmware.vmware_rest.vcenter_vm_hardware_boot:
vm: '{{ test_vm1_info.id }}'
efi_legacy_boot: true
type: EFI
register: _result