vmware.vmware_rest.vcenter_vm_hardware_cdrom 模块 – 向虚拟机添加虚拟 CD-ROM 设备。

注意

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

vmware.vmware_rest 0.1.0 中的新增功能

概要 

向虚拟机添加虚拟 CD-ROM 设备。

要求 

在执行此模块的主机上需要以下要求。

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

参数 

参数	注释
allow_guest_control 布尔值	指示访客是否可以连接和断开设备连接的标志。如果未设置，则值保持不变。选择 `false` `true`
backing 字典	虚拟 CD-ROM 设备的物理资源后备。如果未设置，则默认为自动检测合适的宿主设备。state=['present'] 时必需有效属性为 `type` (str): 此选项定义虚拟 CD-ROM 设备的有效后备类型。（['present']）此键在 ['present'] 中是必需的。接受的值 CLIENT_DEVICE HOST_DEVICE ISO_FILE `iso_file` (str): 应用作虚拟 CD-ROM 设备后备的映像文件的路径。此字段是可选的，并且仅当 type 的值为 ISO_FILE 时才相关。（['present']） `host_device` (str): 应用作虚拟 CD-ROM 设备后备的设备的名称。如果未设置，则虚拟 CD-ROM 设备将配置为自动检测合适的宿主设备。（['present']） `device_access_type` (str): 此选项定义虚拟 CD-ROM 设备的物理设备打包的有效设备访问类型。（['present']）接受的值 EMULATION PASSTHRU PASSTHRU_EXCLUSIVE
cdrom 字符串	虚拟 CD-ROM 设备标识符。该参数必须是由 vmware.vmware_rest.vcenter_vm_hardware_cdrom 返回的资源的 ID。state=['absent'，'connect'，'disconnect'，'present'] 时必需
ide 字典	用于将设备附加到虚拟 IDE 适配器的地址。如果未设置，服务器将选择一个可用的地址；如果没有可用地址，则请求将失败。有效属性为 `primary` (bool): 指定是否应将设备附加到虚拟机的主 IDE 适配器或辅助 IDE 适配器的标志。如果未设置，则服务器将选择具有可用连接的适配器。如果没有可用的 IDE 连接，则请求将被拒绝。（['present']） `master` (bool): 指定该设备应是 IDE 适配器上的主设备还是从设备的标志。如果未设置，则服务器将选择可用的连接类型。如果没有可用的 IDE 连接，则请求将被拒绝。（['present']）
label 字符串	项目的名称
sata 字典	用于将设备附加到虚拟 SATA 适配器的地址。如果未设置，服务器将选择一个可用的地址；如果没有可用地址，则请求将失败。state=['present'] 时必需有效属性为 `bus` (int): 设备应附加到的适配器的总线号。（['present']）此键在 ['present'] 中是必需的。 `unit` (int): 设备的单元号。如果未设置，则服务器将选择指定适配器上的可用单元号。如果适配器上没有可用连接，则请求将被拒绝。（['present']）
session_timeout 浮点数在 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
start_connected 布尔值	指示虚拟机开机时是否应连接虚拟设备的标志。如果未设置，则值保持不变。选择 `false` `true`
state 字符串	选择 `"absent"` `"connect"` `"disconnect"` `"present"` ← (默认)
type 字符串	host_bus_adapter_type 枚举类型定义了可用于将 Cdrom 连接到虚拟机的有效主机总线适配器类型。选择 `"IDE"` `"SATA"`
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: Attach an ISO image to a guest VM
  vmware.vmware_rest.vcenter_vm_hardware_cdrom:
    vm: '{{ test_vm1_info.id }}'
    type: SATA
    sata:
      bus: 0
      unit: 2
    start_connected: true
    backing:
      iso_file: '[ro_datastore] fedora.iso'
      type: ISO_FILE
  register: _result

返回值 

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

键	描述
id 字符串	资源的 moid 返回: 成功时示例: `"16002"`
value 字典	将 ISO 映像附加到客户机 VM 返回: 成功时示例: `{"allow_guest_control": 0, "backing": {"iso_file": "[ro_datastore] fedora.iso", "type": "ISO_FILE"}, "label": "CD/DVD drive 1", "sata": {"bus": 0, "unit": 2}, "start_connected": 1, "state": "NOT_CONNECTED", "type": "SATA"}`

作者

Ansible 云团队 (@ansible-collections)