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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
keys_send list / elements=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 aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
uuid string	UUID экземпляра для сбора фактов, если известен; это уникальный идентификатор VMware. Это обязательный параметр, если параметр `name` или `moid` не указан.

validate_certs

boolean

Разрешает подключение, когда сертификаты 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)

Ссылки на сборку

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