vmware.vmware_rest.vcenter_vm_hardware_boot_device 模块 – 设置虚拟机启动时使用的虚拟设备

注意

此模块是 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_device。

vmware.vmware_rest 0.1.0 中的新增功能

概要 

设置虚拟机启动时使用的虚拟设备。虚拟机将按顺序检查设备，尝试从每个设备启动，直到虚拟机成功启动。如果列表为空，虚拟机将使用默认启动顺序。对于给定的设备类型，列表中不应有多于一个 Device.Entry 实例，ETHERNET 除外。

要求 

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

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

参数 

参数	注释
devices 列表 / 元素=字典 / 必需	启动设备的有序列表。此参数是必需的。有效的属性是 `type` (str): 此选项定义可以用作可启动设备的有效设备类型。（[‘set’]）此键是必需的，带有 [‘set’]。接受的值 CDROM DISK ETHERNET FLOPPY `nic` (str): 虚拟以太网设备。用作此条目启动设备的以太网设备。此字段是可选的，并且仅当 type 的值为 ETHERNET 时才相关。当客户端传递此结构的 value 作为参数时，该字段必须是由 vmware.vmware_rest.vcenter_vm_hardware_ethernet 返回的资源的 id。([‘set’]) `disks` (list): 虚拟磁盘设备。启动顺序中的虚拟磁盘列表。此字段是可选的，并且仅当 type 的值为 DISK 时才相关。当客户端传递此结构的 value 作为参数时，该字段必须包含由 vmware.vmware_rest.vcenter_vm_hardware_disk 返回的资源的 id。([‘set’])
session_timeout 浮点数在 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作的最大秒数，包括连接建立、请求发送和响应。默认值为 300 秒。
state 字符串	选项 `"set"` ←（默认）
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: Set a boot device
  vmware.vmware_rest.vcenter_vm_hardware_boot_device:
    vm: '{{ test_vm1_info.id }}'
    devices:
    - type: CDROM
  register: _result

返回值 

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

键	描述
值字典	设置启动设备返回: 成功时示例: `{}`

作者

Ansible 云团队 (@ansible-collections)