community.vmware.vmware_guest_boot_manager 模块 – 管理给定虚拟机的启动选项

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_guest_boot_manager。

概要

• 此模块可用于管理给定虚拟机的启动选项。

参数

参数	注释
boot_delay 整数	启动序列开始之前的延迟（毫秒）。
boot_firmware 字符串	选择应使用哪个固件启动虚拟机。 选项 "bios" "efi"
boot_hdd_name 字符串 在 community.vmware 3.2.0 中添加	此参数是可选的，如果未设置，将使用在 VM 设备列表中找到的第一个虚拟磁盘。
boot_order 列表 / elements=string	启动设备列表。 默认值： []
boot_retry_delay 整数	指定虚拟机启动失败与后续尝试再次启动之间的时间（毫秒）。 如果设置，将自动设置 boot_retry_enabled=true，因为此参数是必需的。
boot_retry_enabled 布尔值	如果设置为 true，则启动失败的虚拟机将在 boot_retry_delay 过期后尝试再次启动。 如果设置为 false，则虚拟机将无限期地等待用户干预。 选项 false true
enter_bios_setup 布尔值	如果设置为 true，则虚拟机将在下次启动时自动进入 BIOS 设置。 虚拟机将重置此标志，以便机器正常启动。 选项 false true
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果未在任务中指定该值，则将改为使用环境变量 VMWARE_HOST 的值。
moid 字符串	如果已知要管理的实例的托管对象 ID，则这是仅在单个 vCenter 实例中唯一的标识符。 如果未提供 name 或 uuid，则这是必需的。
name 字符串	要使用的 VM 的名称。 如果未提供 uuid 或 moid 参数，则这是必需的。
name_match 字符串	如果多个虚拟机匹配该名称，请使用找到的第一个或最后一个。 选项 "first" ←（默认） "last"
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PORT 的值。 默认值： 443
proxy_host 字符串	将接收所有 HTTPS 请求并中继它们的代理的地址。 格式为主机名或 IP。 如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并中继它们的 HTTP 代理的端口。 如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PROXY_PORT 的值。
secure_boot_enabled 布尔值	选择是否应启用 EFI 安全启动。EFI 安全启动只能在 boot_firmware = efi 时启用 选项 false true
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项 false ← (默认) true
username 别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。
uuid 字符串	要管理的实例的 UUID（如果已知），默认情况下这是 VMware 的 BIOS UUID。 如果未提供 name 或 moid 参数，则此为必需参数。
validate_certs 布尔值	允许在 SSL 证书无效时进行连接。当证书不可信任时，设置为 false。 如果任务中未指定该值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。 选项 false true ← (默认)

注意

注意

• 所有模块都需要 API 写入权限，因此不支持免费的 ESXi 许可证。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- 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

返回值

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

vm_boot_status 字典

关于虚拟机启动顺序的元数据 返回: 始终 示例: {"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}

作者

• Abhijeet Kasurde (@Akasurde)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)