community.general.shutdown module – Shut down a machine
Note
This module is part of the community.general collection (version 9.4.0).
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 community.general 1.1.0
Synopsis
Shut downs a machine.
Note
This module has a corresponding action plugin.
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: |
|
Message to display to users before shutdown. Default: |
|
Paths to search on the remote machine for the Only these paths will be searched for the Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller. |
|
Support: full |
Supports being used with the |
|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
PATH
is ignored on the remote node when searching for theshutdown
command. Usesearch_paths
to specify locations to search if the default paths do not work.The
msg
anddelay
options are not supported when a shutdown command is not found insearch_paths
, instead the module will attempt to shutdown the system by callingsystemctl shutdown
.
See Also
See also
- ansible.builtin.reboot
Reboot a machine.
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: |