Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.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

целое число

Минуты, спустя которые должно начаться выключение. Если указано 0, выключение начнется немедленно. Требуется при state=[‘poweroff’, ‘reboot’]

reason

строка

Причина выполнения выключения. Требуется при state=[‘poweroff’, ‘reboot’]

session_timeout

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

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

Параметры таймаута сессии клиента.

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

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

state

строка / обязательно

Варианты:

  • "cancel"
  • "poweroff"
  • "reboot"

vcenter_hostname

строка / обязательно

Имя хоста или IP-адрес vCenter vSphere

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

... (остальные строки) ...

Примечания

Примечание

  • Тестировалось на 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

словарь

Прервать перезагрузку

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

Пример: {}

Авторы

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

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (Исходный код)

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

Spec-Zone.ru

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