Модуль community.proxmox.proxmox_sendkey — отправка нажатий клавиш в консоль ВМ Proxmox

Примечание

Этот модуль является частью коллекции community.proxmox (версия 1.6.0).

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

Для установки используйте: ansible-galaxy collection install community.proxmox. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_sendkey.

Добавлено в community.proxmox 1.5.0

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

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

Использует API Proxmox для отправки последовательности нажатий клавиш в консоль ВМ.
Клавиши можно указать явно или получить из обычной текстовой строки.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой узел кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение по времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
delay float	Задержка в секундах между нажатиями клавиш. По умолчанию: `0.0`
keys_send list / элементы=string	Список клавиш или последовательность клавиш для отправки по порядку. Каждый элемент должен соответствовать формату имен клавиш qemu, например `ctrl-alt-delete` или `ret`. Можно указать либо `keys_send`, либо `string_send`.
name string	Уникальное имя ВМ.
string_send string	Исходная строка, которая будет преобразована в соответствующие нажатия клавиш Поддерживаются только символы ASCII. перед отправкой. Можно указать либо `keys_send`, либо `string_send`.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vmid integer	Уникальный идентификатор ВМ. Имеет приоритет над `name`.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.proxmox.proxmox	Используйте `group/community.proxmox.proxmox` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примечания

Примечание

Имена клавиш должны соответствовать именам клавиш qemu, указанным в QEMU ui.QKeyCode.

Примеры

- name: Send Ctrl+Alt+Delete to a Windows VM
  proxmox_sendkey:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    name: win-test
    keys_send:
      - ctrl-alt-delete

- name: Type a login string into a Linux VM console
  proxmox_sendkey:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    vmid: 101
    string_send: |
        root
        P@ssw0rd
    delay: 1.0

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
completed_keys_num integer	Количество клавиш, отправленных в консоль ВМ. Возвращается: success Пример: `5`
keys_num integer	Количество клавиш, отправленных в консоль ВМ. Возвращается: success Пример: `5`
total_keys list / элементы=string	Список клавиш, отправленных в консоль ВМ. Возвращается: success Пример: `["H", "e", "l", "l", "o"]`
vmid integer	Идентификатор vmid виртуальной машины. Возвращается: success Пример: `101`

Авторы

miyuk (@miyuk172)

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

© 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/proxmox/proxmox_sendkey_module.html