vmware.vmware_rest.vcenter_vm_hardware_boot 模块 – 更新虚拟机的启动相关设置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install vmware.vmware_rest。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：vmware.vmware_rest.vcenter_vm_hardware_boot。

vmware.vmware_rest 0.1.0 中的新增功能

概要 

更新虚拟机的启动相关设置。

要求 

执行此模块的主机需要满足以下要求。

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
delay 整数	虚拟机开机时，在开始固件启动过程之前延迟的毫秒数。此延迟可用于为用户提供连接到虚拟机控制台并进入 BIOS 设置模式的时间窗口。如果未设置，则值保持不变。
efi_legacy_boot 布尔值	标志，指示是否使用 EFI 传统启动模式。如果未设置，则值保持不变。选择 `false` `true`
enter_setup_mode 布尔值	标志，指示固件启动过程是否应在下次虚拟机启动时自动进入设置模式。请注意，一旦虚拟机进入设置模式，此标志将自动重置为 false。如果未设置，则值保持不变。选择 `false` `true`
network_protocol 字符串	network_protocol 枚举类型定义了通过网络使用 EFI 固件启动虚拟机时支持的有效网络启动协议。选择 `"IPV4"` `"IPV6"`
retry 布尔值	标志，指示虚拟机是否应在失败后自动重试启动过程。如果未设置，则值保持不变。选择 `false` `true`
retry_delay 整数	在失败后重试启动过程之前的延迟（以毫秒为单位）；仅当 retry 为 true 时适用。如果未设置，则值保持不变。
session_timeout 浮点数在 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
state 字符串	选择 `"present"` ← (默认)
type 字符串	type 枚举类型定义了虚拟机的有效固件类型。选择 `"BIOS"` `"EFI"`
vcenter_hostname 字符串 / 必填	vSphere vCenter 的主机名或 IP 地址如果未在任务中指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
vcenter_password 字符串 / 必填	vSphere vCenter 密码如果未在任务中指定该值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
vcenter_rest_log_file 字符串	您可以使用此可选参数来设置日志文件的位置。此文件将用于记录 HTTP REST 交互。该文件将存储在运行该模块的主机上。如果未在任务中指定该值，则将使用环境变量 `VMWARE_REST_LOG_FILE` 的值。
vcenter_username 字符串 / 必填	vSphere vCenter 用户名如果未在任务中指定该值，则将使用环境变量 `VMWARE_USER` 的值。
vcenter_validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选择 `false` `true` ← (默认)
vm 字符串 / 必填	虚拟机标识符。该参数必须是由 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。此参数是强制性的。

注释 

注意

在 vSphere 7.0.3 上测试

示例 

- 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

返回值 

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

键	描述
id 字典	资源的 moid 返回: 成功时
value 字典	更改 VM 启动参数返回: 成功时示例: `{}`

作者

Ansible 云团队 (@ansible-collections)