Try SpotterManage boot options for the given virtual machine
Authors: Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections:
- name: community.vmware
version: 4.2.0This module can be used to manage boot options for the given virtual machine.
- name: Change virtual machine's boot order and related parameters
community.vmware.vmware_guest_boot_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
name: testvm
boot_delay: 2000
enter_bios_setup: true
boot_retry_enabled: true
boot_retry_delay: 22300
boot_firmware: bios
secure_boot_enabled: false
boot_order:
- floppy
- cdrom
- ethernet
- disk
delegate_to: localhost
register: vm_boot_order
- name: Change virtual machine's boot order using Virtual Machine MoID
community.vmware.vmware_guest_boot_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
moid: vm-42
boot_delay: 2000
enter_bios_setup: true
boot_retry_enabled: true
boot_retry_delay: 22300
boot_firmware: bios
secure_boot_enabled: false
boot_order:
- floppy
- cdrom
- ethernet
- disk
delegate_to: localhost
register: vm_boot_order
moid:
description:
- 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 O(name) or O(uuid) is not supplied.
type: str
name:
description:
- Name of the VM to work with.
- This is required if O(uuid) or O(moid) parameter is not supplied.
type: str
port:
default: 443
description:
- The port number of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
will be used instead.
type: int
uuid:
description:
- UUID of the instance to manage if known, this is VMware's BIOS UUID by default.
- This is required if O(name) or O(moid) parameter is not supplied.
type: str
hostname:
description:
- 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 E(VMWARE_HOST)
will be used instead.
type: str
password:
aliases:
- pass
- pwd
description:
- The password of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
will be used instead.
type: str
username:
aliases:
- admin
- user
description:
- The username of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
will be used instead.
type: str
boot_delay:
description:
- Delay in milliseconds before starting the boot sequence.
type: int
boot_order:
default: []
description:
- List of the boot devices.
elements: str
type: list
name_match:
choices:
- first
- last
default: first
description:
- If multiple virtual machines matching the name, use the first or last found.
type: str
proxy_host:
description:
- 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 E(VMWARE_PROXY_HOST)
will be used instead.
required: false
type: str
proxy_port:
description:
- 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 E(VMWARE_PROXY_PORT)
will be used instead.
required: false
type: int
boot_firmware:
choices:
- bios
- efi
description:
- Choose which firmware should be used to boot the virtual machine.
type: str
boot_hdd_name:
description:
- Name of disk to be set as boot disk, which is case sensitive, e.g., 'Hard disk 1'.
- This parameter is optional, if not set, will use the first virtual disk found in
VM device list.
type: str
version_added: 3.2.0
version_added_collection: community.vmware
validate_certs:
default: true
description:
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates
are not trusted.
- If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
will be used instead.
type: bool
boot_retry_delay:
description:
- Specify the time in milliseconds between virtual machine boot failure and subsequent
attempt to boot again.
- If set, will automatically set O(boot_retry_enabled=true) as this parameter is required.
type: int
enter_bios_setup:
description:
- If set to V(true), the virtual machine automatically enters BIOS setup the next
time it boots.
- The virtual machine resets this flag, so that the machine boots proceeds normally.
type: bool
use_instance_uuid:
default: false
description:
- Whether to use the VMware instance UUID rather than the BIOS UUID.
type: bool
boot_retry_enabled:
description:
- If set to V(true), the virtual machine that fails to boot, will try to boot again
after O(boot_retry_delay) is expired.
- If set to V(false), the virtual machine waits indefinitely for user intervention.
type: bool
secure_boot_enabled:
description:
- Choose if EFI secure boot should be enabled. EFI secure boot can only be enabled
with boot_firmware = efi
type: bool
vm_boot_status:
description: metadata about boot order of virtual machine
returned: always
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
previous_boot_delay: 10
previous_boot_firmware: efi
previous_boot_order:
- ethernet
- cdrom
- floppy
- disk
previous_boot_retry_delay: 10000
previous_boot_retry_enabled: true
previous_enter_bios_setup: false
previous_secure_boot_enabled: true
type: dict