Spec-Zone.ru › Ansible

модуль vmware.vmware_rest.appliance_shutdown_info — получение сведений о запланированном завершении работы.

Примечание

Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.appliance_shutdown_info.

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

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

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

  • Получение сведений о запланированном завершении работы.

Требования

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

  • vSphere 7.0.3 или более поздней версии
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

session_timeout

число с плавающей точкой

добавлено в vmware.vmware_rest 2.1.0

Настройки времени ожидания для клиентского сеанса.

Максимальное количество секунд, отведённое на всю операцию, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 с.

vcenter_hostname

строка / обязательный параметр

Имя узла или IP-адрес vCenter vSphere.

Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_HOST.

vcenter_password

строка / обязательный параметр

Пароль vCenter vSphere.

Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_PASSWORD.

vcenter_rest_log_file

строка

С помощью этого необязательного параметра можно указать расположение файла журнала.

Этот файл будет использоваться для записи взаимодействия по HTTP REST.

Файл будет сохранён на узле, на котором выполняется модуль.

Если значение не указано в задаче, вместо него будет использоваться значение

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

строка / обязательный параметр

Имя пользователя vCenter vSphere.

Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_USER.

vcenter_validate_certs

логическое значение

Разрешает подключение, если SSL-сертификаты недействительны. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Проверено на vSphere 7.0.3

Примеры

- name: Ensure there is no ongoing shutdown
  vmware.vmware_rest.appliance_shutdown_info:
  register: result

- name: Get the ongoing shutdown
  vmware.vmware_rest.appliance_shutdown_info:
  register: result

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

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

Ключ

Описание

value

словарь

Сведения о выполняемом завершении работы.

Возвращается: при успешном выполнении

Пример: {"action": "reboot", "reason": "this is an example", "shutdown_time": "2022-11-24T06:12:16.000Z"}

Авторы

  • Команда 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_shutdown_info_module.html

Spec-Zone.ru

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