community.vmware.vmware_guest_sendkey – Отправка кодов USB HID на клавиатуру виртуальной машины.
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в книге задач укажите: community.vmware.vmware_guest_sendkey.
Обзор
- Этот модуль используется для отправки нажатий клавиш заданной виртуальной машине.
- Все параметры и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| keys_send список / элементы=строка | Список клавиш, которые будут отправлены виртуальной машине. Допустимые значения: ENTER, ESC, BACKSPACE, TAB, SPACE, CAPSLOCK, DELETE, CTRL_ALT_DEL, CTRL_C и F1 до F12, RIGHTARROW, LEFTARROW, DOWNARROW, UPARROW. Если указаны как keys_send, так и string_send, ключи в списке keys_send будут отправлены перед string_send. | |
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Требуется, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины. Обязательный параметр, если параметр uuid или moid не указан. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | |
| sleep_time целое число добавлен в 1.4.0 community.vmware | Значение по умолчанию: 0 | Время ожидания в секундах между двумя клавишами или строкой, отправленной виртуальной машине. API быстрее, чем фактическая отправка клавиши или строки виртуальной машине. Этот параметр позволяет управлять задержкой между клавишами и/или строками. |
| string_send строка | Строка, которая будет отправлена виртуальной машине. Эта строка может содержать допустимые специальные символы, буквы и цифры на клавиатуре. | |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID экземпляра для сбора фактов, если известен. Это уникальный идентификатор VMware. Обязательный параметр, если параметр name или moid не указан. | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, если сертификаты не доверяются.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Тестировалось на vSphere 6.5 и 6.7
Примеры
- 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': ['ПРОБЕЛ', 'ВНИЗ', 'ВНИЗ', 'ВВОД'], 'keys_send_number': 4, 'returned_keys_send_number': 4, 'string_send': None, 'virtual_machine': 'test_vm'} |
Авторы
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_sendkey_module.html
