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

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

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

Чтобы использовать его в книге задач, укажите: community.general.shutdown.

Новое в community.general 1.1.0

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: полная	Указывает, что есть соответствующий плагин действий, поэтому некоторые части параметров могут быть выполнены на контроллере.
async	Поддержка: полная	Поддерживает использование ключевого слова `async`.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`) при включении режима diff.

Примечания

Примечание

PATH игнорируется на удалённом узле при поиске команды shutdown. Используйте search_paths для указания местоположений поиска, если стандартные пути не работают.
Параметры msg и delay не поддерживаются, если команда выключения не найдена в search_paths, вместо этого модуль попытается выключить систему, вызвав systemctl shutdown.

См. также

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/shutdown_module.html