Модуль vmware.vmware_rest.appliance_shutdown — отмена ожидающего действия выключения.

Примечание

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

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

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

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

Отмена ожидающего действия выключения.

Требования

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

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

Параметры

Параметр	Комментарии
delay integer	Количество минут до начала выключения. Если указано значение 0, выключение начнется немедленно. Обязательно при state=[‘poweroff’, ‘reboot’]
reason string	Причина выключения. Обязательно при state=[‘poweroff’, ‘reboot’]
session_timeout float Добавлено в vmware.vmware_rest 2.1.0	Настройки тайм-аута сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state string / обязательно	Варианты: `"cancel"` `"poweroff"` `"reboot"`
vcenter_hostname string / обязательно	Имя узла или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password string / обязательно	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file string	С помощью этого необязательного параметра можно задать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия с HTTP REST API. Файл будет сохранен на узле, на котором выполняется модуль. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username string / обязательно	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Shutdown the appliance
  vmware.vmware_rest.appliance_shutdown:
    state: poweroff
    reason: this is an example
    delay: 600
  register: result

- name: Abort the shutdown of the appliance
  vmware.vmware_rest.appliance_shutdown:
    state: cancel
  register: result

- name: Reboot the appliance
  vmware.vmware_rest.appliance_shutdown:
    state: reboot
    reason: this is an example
    delay: 600
  register: result

- name: Abort the reboot
  vmware.vmware_rest.appliance_shutdown:
    state: cancel
  register: result

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

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

Ключ	Описание
value dictionary	Прервать перезагрузку Возвращается: При успешном выполнении Пример: `{}`

Авторы

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