community.general.shutdown – Shut down a machine
Note
This plugin is part of the community.general collection (version 3.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.shutdown
.
New in version 1.1.0: of community.general
Parameters
Parameter |
Comments |
---|---|
Seconds to wait before shutdown. Passed as a parameter to the shutdown command. On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it will be set to 0. On Solaris and FreeBSD, this will be seconds. Default: 0 |
|
Message to display to users before shutdown. Default: “Shut down initiated by Ansible” |
|
Paths to search on the remote machine for the Only these paths will be searched for the Default: [“/sbin”, “/usr/sbin”, “/usr/local/sbin”] |
Notes
Note
PATH
is ignored on the remote node when searching for theshutdown
command. Use search_paths to specify locations to search if the default paths do not work.
See Also
See also
- ansible.builtin.reboot
The official documentation on the ansible.builtin.reboot module.
Examples
- 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'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returned: always Sample: true |
Authors
Matt Davis (@nitzmahone)
Sam Doran (@samdoran)
Amin Vakil (@aminvakil)