community.general.shutdown – Выключение машины

Примечание

Этот плагин входит в состав коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.shutdown.

Новое в версии 1.1.0: из community.general

Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Выключает машину.

Примечание

Данный модуль имеет соответствующий плагин плагина действий.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
delay целое число	По умолчанию: 0	Секунды ожидания перед выключением. Передается как параметр команде выключения. В Linux, macOS и OpenBSD это преобразуется в минуты и округляется вниз. Если меньше 60, оно будет установлено в 0. В Solaris и FreeBSD это будут секунды.
msg строка	По умолчанию: "Выключение инициировано Ansible"	Сообщение для отображения пользователям перед выключением.
search_paths список / элементы=путь	По умолчанию: ["/sbin", "/usr/sbin", "/usr/local/sbin"]	Пути для поиска на удаленной машине команды `shutdown`. Только эти пути будут просматриваться для команды `shutdown`. `PATH` игнорируется на удаленном узле при поиске команды `shutdown`.

Примечания

Примечание

PATH игнорируется на удаленном узле при поиске команды shutdown. Используйте search_paths для указания местоположений поиска, если стандартные пути не работают.

См. также

ansible.builtin.reboot: Официальная документация модуля ansible.builtin.reboot.

Примеры

- name: Unconditionally shut down the machine with all defaults
  community.general.shutdown:

- name: Delay shutting down the remote node
  community.general.shutdown:
    delay: 60

- name: Shut down a machine with shutdown command in unusual place
  community.general.shutdown:
    search_paths:
     - '/lib/molly-guard'

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

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

Ключ	Возвращаемое значение	Описание
shutdown булево	всегда	`true` если машина была выключена. Пример: True

Авторы

Matt Davis (@nitzmahone)
Sam Doran (@samdoran)
Amin Vakil (@aminvakil)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/shutdown_module.html