Spec-Zone.ru › Ansible 2.9

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

Новая в версии 2.9.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Этот модуль используется для отправки нажатий клавиш на заданную виртуальную машину.
  • Все параметры и имена объектов 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-адрес сервера vSphere vCenter или 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
строка
Пароль сервера vSphere vCenter или ESXi.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PASSWORD.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: pass, pwd
port
целое число
добавлено в 2.5
По умолчанию:
443
Порт сервера vSphere vCenter или ESXi.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PORT.
Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host
строка
добавлено в 2.9
Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их.
Формат — имя хоста или IP-адрес.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PROXY_HOST.
Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port
целое число
добавлено в 2.9
Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PROXY_PORT.
string_send
строка
Строка, которая будет отправлена на виртуальную машину.
Эта строка может содержать допустимые специальные символы, буквы и цифры на клавиатуре.
username
строка
Имя пользователя сервера vSphere vCenter или ESXi.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_USER.
Поддержка переменных среды добавлена в Ansible 2.6.

псевдонимы: admin, user
uuid
строка
UUID экземпляра для сбора фактов, если известен. Это уникальный идентификатор VMware.
Этот параметр обязателен, если параметр name или moid не указан.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, когда сертификаты не доверяются.
Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_VALIDATE_CERTS.
Поддержка переменных среды добавлена в Ansible 2.6.
Если установлено значение yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

  • Тестировалось на vSphere 6.5 и 6.7

Примеры

- name: Send list of keys to virtual machine
  vmware_guest_sendkey:
    validate_certs: no
    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
  vmware_guest_sendkey:
    validate_certs: no
    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
  vmware_guest_sendkey:
    validate_certs: no
    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
словарь
всегда
отображает нажатые клавиши и количество отправленных на виртуальную машину

Пример:
{'virtual_machine': 'test_vm', 'keys_send': ['SPACE', 'DOWNARROW', 'DOWNARROW', 'ENTER'], 'string_send': None, 'keys_send_number': 4, 'returned_keys_send_number': 4}


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/vmware_guest_sendkey_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API