модуль vmware.vmware_rest.appliance_access_ssh_info — Получение состояния включения управляемого CLI на основе SSH.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.appliance_access_ssh_info.
Добавлено в vmware.vmware_rest 2.0.0
УСТАРЕЛО
- Удалено в:
-
версии 5.0.0
- Причина:
-
Этот модуль перенесен в новую коллекцию vmware.vmware
- Альтернатива:
-
Вместо него используйте vmware.vmware.appliance_info.
Краткое описание
- Получение состояния включения управляемого CLI на основе SSH.
Требования
На хосте, где выполняется этот модуль, необходимы следующие компоненты.
- vSphere 7.0.3 или новее
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для сеанса клиента. Максимальное время в секундах для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
vcenter_hostname string / обязательный | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password string / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file string | Этот необязательный параметр позволяет задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранен на хосте, где выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username string / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение, если SSL-сертификаты недействительны. Установите значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
Примечания
Примечание
- Проверено на vSphere 7.0.3
Примеры
- name: Check is the SSH access is enabled vmware.vmware_rest.appliance_access_ssh_info: register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
value integer | Проверка, включен ли доступ по SSH Возвращается: При успешном выполнении Пример: |
Статус
- Этот модуль будет удален в версии 5.0.0. [устарело]
- Дополнительную информацию см. в разделе УСТАРЕЛО.
Ссылки на коллекцию
© 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/vmware/vmware_rest/appliance_access_ssh_info_module.html