community.general.shutdown – Выключение компьютера

Примечание

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

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

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

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

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

Обзор

Выключает компьютер.

Примечание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
delay целое число	Значение по умолчанию: 0	Время ожидания перед выключением в секундах. Передается как параметр команде shutdown. В 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/shutdown_module.html