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。

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

概要

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

参数

参数	注释
群集 字符串	虚拟机正在运行的群集的名称。 如果未设置 esxi_hostname，则此参数为必需参数。 esxi_hostname 和 cluster 是互斥的。
数据中心 字符串	虚拟机所属的数据中心名称。
esxi_hostname 字符串	虚拟机正在运行的 ESXi 主机名。 如果未设置 cluster，则此参数为必需参数。 esxi_hostname 和 cluster 是互斥的。
文件夹 字符串	目标文件夹，用于查找现有客户机的绝对或相对路径。 仅当找到多个同名的虚拟机时，此参数才为必需参数。 文件夹应包括数据中心。ESXi 服务器的数据中心是 ha-datacenter。 示例 文件夹：/ha-datacenter/vm 文件夹：ha-datacenter/vm 文件夹：/datacenter1/vm 文件夹：datacenter1/vm 文件夹：/datacenter1/vm/folder1 文件夹：datacenter1/vm/folder1 文件夹：/folder1/datacenter1/vm 文件夹：folder1/datacenter1/vm 文件夹：/folder1/datacenter1/vm/folder2
主机名 字符串	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，这是仅在单个 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)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）