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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.shutdown.

Добавлено в community.general 1.1.0

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

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

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

Примечание

Этому модулю соответствует плагин действия.

Параметры

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

Атрибуты

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

Примечания

Примечание

Переменная 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/shutdown_module.html