community.general.shutdown – Shut down a machine
community.general.shutdown – Shut down a machine
Note
This plugin is part of the community.general collection (version 2.0.1).
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
Synopsis
- Shut downs a machine.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
delay integer |
Default: 0 |
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. |
|
msg string |
Default: "Shut down initiated by Ansible" |
Message to display to users before shutdown. |
|
search_paths list / elements=path |
Default: ["/sbin", "/usr/sbin", "/usr/local/sbin"] |
Paths to search on the remote machine for the Only these paths will be searched for the |
Notes
Note
PATHis ignored on the remote node when searching for theshutdowncommand. Use search_paths to specify locations to search if the default paths do not work.
See Also
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 | Returned | Description |
|---|---|---|
|
shutdown boolean |
always |
Sample: True |
Authors
- 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
