Модуль vmware.vmware_rest.appliance_access_shell — установка состояния доступности BASH, то есть доступа к BASH из контролируемого CLI.

Примечание

Этот модуль входит в коллекцию 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_shell.

Добавлено в vmware.vmware_rest 2.0.0

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

УСТАРЕЛО

Удалено в:: версии 5.0.0
Причина:: Этот модуль перенесён в новую коллекцию vmware.vmware
Альтернатива:: Вместо него используйте vmware.vmware.vcsa_settings.

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

Установка состояния доступности BASH, то есть доступа к BASH из контролируемого CLI.

Требования

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

vSphere 7.0.3 или новее
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
enabled логическое значение / обязательный	Для параметра enabled можно задать значение true или false. Этот параметр обязателен. Варианты: `false` `true`
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для сеанса клиента. Максимальное время в секундах для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state строка	Варианты: `"set"` ← (по умолчанию)
timeout целое число / обязательный	Время ожидания (в секундах) задаёт, на какой срок будет включён доступ к Shell. Максимальное время ожидания — 86400 секунд (1 день). Этот параметр обязателен.
vcenter_hostname строка / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	С помощью этого необязательного параметра можно указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет сохранён на узле, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, задайте значение `false`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Проверено на 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 словарь	Отключение Shell Возвращается: При успешном выполнении Пример: `{"enabled": 0, "timeout": 0}`

Статус

Этот модуль будет удалён в версии 5.0.0. [устарел]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Команда Ansible Cloud (@ansible-collections)

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

© 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_shell_module.html