community.vmware.vmware_guest_sendkey 模块 – 向虚拟机的键盘发送 USB HID 代码。

注意

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

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

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

要在剧本中使用它，请指定： community.vmware.vmware_guest_sendkey。

概要

• 此模块用于向指定的虚拟机发送按键。

参数

参数	注释
cluster 字符串	运行虚拟机的集群名称。 如果未设置 esxi_hostname，则此参数为必填参数。 esxi_hostname 和 cluster 是互斥的。
datacenter 字符串	虚拟机所属的数据中心名称。
esxi_hostname 字符串	运行虚拟机的 ESXi 主机名。 如果未设置 cluster，则此参数为必填参数。 esxi_hostname 和 cluster 是互斥的。
folder 字符串	目标文件夹，查找现有客户机的绝对或相对路径。 只有在找到多个具有相同名称的虚拟机时，此参数才为必填参数。 文件夹应包含数据中心。ESXi 服务器的数据中心是 ha-datacenter。 示例 folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 VMWARE_HOST 的值。
keys_send 列表 / 元素=字符串	将发送到虚拟机的键列表。 有效值为 ENTER、ESC、BACKSPACE、TAB、SPACE、CAPSLOCK、HOME、DELETE、END、CTRL_ALT_DEL、CTRL_C、CTRL_X 和 F1 到 F12、RIGHTARROW、LEFTARROW、DOWNARROW、UPARROW、WINDOWS。 如果同时指定了 keys_send 和 string_send，则 keys_send 列表中的键将发送到 string_send 的前面。 默认值： []
moid 字符串	已知实例的托管对象 ID，此 ID 仅在单个 vCenter 实例中唯一。 如果未提供name 或 uuid，则需要此参数。
name 字符串	虚拟机的名称。 如果未提供参数uuid 或 moid，则此参数为必填参数。
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的值。
sleep_time 整数	发送到虚拟机的两个按键或字符串之间的睡眠时间（秒）。 API 比实际发送到虚拟机的按键或字符串速度快，此参数允许控制按键和/或字符串之间的延迟。 默认值： 0
string_send 字符串	将发送到虚拟机的字符串。 此字符串可以包含键盘上的有效特殊字符、字母和数字。 如果同时指定了 keys_send 和 string_send，则 keys_send 列表中的键将发送到 string_send 的前面。
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定此值，则将使用环境变量VMWARE_USER的值。
uuid 字符串	已知实例的 UUID，这是 VMware 的唯一标识符。 如果未提供参数name 或 moid，则此参数为必填参数。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为false。 如果任务中未指定此值，则将使用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

备注

注意

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

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

示例

- name: Send list of keys to virtual machine
  community.vmware.vmware_guest_sendkey:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "{{ folder_name }}"
    name: "{{ vm_name }}"
    keys_send:
      - TAB
      - TAB
      - ENTER
  delegate_to: localhost
  register: keys_num_sent

- name: Send list of keys to virtual machine using MoID
  community.vmware.vmware_guest_sendkey:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "{{ folder_name }}"
    moid: vm-42
    keys_send:
      - CTRL_ALT_DEL
  delegate_to: localhost
  register: ctrl_alt_del_sent

- name: Send a string to virtual machine
  community.vmware.vmware_guest_sendkey:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "{{ folder_name }}"
    name: "{{ vm_name }}"
    string_send: "user_logon"
  delegate_to: localhost
  register: keys_num_sent

返回值

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

键	描述
sendkey_info 字典	显示发送到虚拟机的按键及其数量。 返回：始终返回 示例： {"keys_send": ["SPACE", "DOWNARROW", "DOWNARROW", "ENTER"], "keys_send_number": 4, "returned_keys_send_number": 4, "string_send": null, "virtual_machine": "test_vm"}

作者

• Diane Wang (@Tomorrow9)

资源链接

• 问题追踪器
• 主页
• 代码仓库