Модуль vmware.vmware_rest.appliance_access_shell — Установка состояния разрешения доступа к BASH из управляемой командной строки.
Примечание
Этот модуль входит в состав коллекции vmware.vmware_rest (версия 3.2.0).
Если вы используете пакет ansible, эта коллекция, возможно, уже установлена. Она не входит в состав ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля потребуются дополнительные зависимости. Подробнее см. Требования.
Для использования в плейбуке укажите: vmware.vmware_rest.appliance_access_shell.
Новый в vmware.vmware_rest 2.0.0
Описание
- Установка состояния разрешения доступа к BASH из управляемой командной строки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- vSphere 7.0.3 или более поздняя версия
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
enabled boolean / обязательный | Enabled может быть установлен в значение true или false. Этот параметр обязателен. Значения:
|
session_timeout float добавлен в vmware.vmware_rest 2.1.0 | Параметры таймаута для сессии клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию составляет 300 секунд. |
state строка | Значения:
|
timeout целое число / обязательный | Таймаут (в секундах) определяет, как долго доступ к Shell будет активен. Максимальный таймаут составляет 86400 секунд (1 день). Этот параметр обязателен. |
vcenter_hostname string / обязательно | Имя хоста или IP-адрес vCenter vSphere Если значение не указано в задаче, будет использовано значение переменной окружения |
vcenter_password string / обязательно | Пароль vCenter vSphere Если значение не указано в задаче, будет использовано значение переменной окружения |
vcenter_rest_log_file string | Вы можете использовать этот необязательный параметр для указания расположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, будет использовано значение переменной окружения |
vcenter_username string / обязательно | Имя пользователя vCenter vSphere Если значение не указано в задаче, будет использовано значение переменной окружения |
vcenter_validate_certs boolean | Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в Если значение не указано в задаче, будет использовано значение переменной окружения Варианты:
|
Примечания
Примечание
- Тестировалось на vSphere 7.0.3
Примеры
- name: Disable the Shell
vmware.vmware_rest.appliance_access_shell:
enabled: false
timeout: 600
- name: Enable the Shell with a timeout
vmware.vmware_rest.appliance_access_shell:
enabled: true
timeout: 600
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
value словарь | Отключить оболочку Возвращено: При успехе Пример: |
Ссылки на сборку
© 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/vmware/vmware_rest/appliance_access_shell_module.html