Модуль community.vmware.vmware_guest_sendkey — отправка USB HID-кодов на клавиатуру виртуальной машины.

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_sendkey.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль используется для отправки нажатий клавиш указанной виртуальной машине.

Параметры

Параметр	Комментарии
cluster string	Имя кластера, в котором запущена виртуальная машина. Этот параметр обязателен, если не задан `esxi_hostname`. `esxi_hostname` и `cluster` являются взаимоисключающими.
datacenter string	Имя центра обработки данных, к которому относится виртуальная машина.
esxi_hostname string	Имя хоста ESXi, на котором запущена виртуальная машина. Этот параметр обязателен, если не задан `cluster`. `esxi_hostname` и `cluster` являются взаимоисключающими.
folder string	Целевая папка: абсолютный или относительный путь для поиска существующей гостевой системы. Этот параметр обязателен только в том случае, если найдено несколько виртуальных машин с одинаковым именем. Путь к папке должен включать центр обработки данных. Центр обработки данных сервера 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 string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
keys_send list / элементы=string	Список клавиш, которые будут отправлены виртуальной машине. Допустимые значения: `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 string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не задан `name` или `uuid`.
name string	Имя виртуальной машины. Этот параметр обязателен, если не задан параметр `uuid` или `moid`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Указывается имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PROXY_PORT`.
sleep_time integer	Время ожидания в секундах между отправкой двух клавиш или строк виртуальной машине. API работает быстрее, чем фактическая отправка клавиши или строки виртуальной машине; этот параметр позволяет управлять задержкой между клавишами и/или строками. По умолчанию: `0`
string_send string	Строка, которая будет отправлена виртуальной машине. Строка может содержать допустимые специальные символы, буквы и цифры, имеющиеся на клавиатуре. Если заданы и `keys_send`, и `string_send`, клавиши из списка `keys_send` будут отправлены перед `string_send`.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра для сбора фактов, если он известен. Это уникальный идентификатор VMware. Этот параметр обязателен, если не задан параметр `name` или `moid`.
validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Всем модулям необходим доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях значение ‘false’ для параметра ‘validate_certs’ может быть проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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 dictionary	отображает клавиши и количество клавиш, отправленных виртуальной машине Возвращается: всегда Пример: `{"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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_sendkey_module.html