ansible.builtin.reboot module – Reboot a machine
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
reboot
even without specifying the collections keyword.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.reboot
for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in Ansible 2.7
Synopsis
Reboot a machine, wait for it to go down, come back up, and respond to commands.
For Windows targets, use the ansible.windows.win_reboot module instead.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Command to run that returns a unique string indicating the last time the system was booted. Setting this to a command that has different output each time it is run will cause the task to fail. Default: |
|
Maximum seconds to wait for a successful connection to the managed hosts before trying again. If unspecified, the default setting for the underlying connection plugin is used. |
|
Message to display to users before reboot. Default: |
|
Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully. This is useful if you want wait for something to settle despite your connection already working. Default: |
|
Seconds to wait before reboot. Passed as a parameter to the reboot 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: |
|
Command to run that reboots the system, including any parameters passed to the command. Can be an absolute path to the command or just the command name. If an absolute path to the command is not given, This will cause Default: |
|
Maximum seconds to wait for machine to reboot and respond to a test command. This timeout is evaluated separately for both reboot verification and test command success so the maximum execution time for the module is twice this amount. Default: |
|
Paths to search on the remote machine for the Only these paths will be searched for the Default: |
|
Command to run on the rebooted host and expect success from to determine the machine is ready for further tasks. 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: none |
Supports being used with the |
|
Support: none |
Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations Conditionals will work as if This action will not work normally outside of lockstep strategies |
|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: none |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platform: posix |
Target OS/families that can be operated against |
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.
See Also
See also
- ansible.windows.win_reboot
Reboot a windows machine.
Examples
- name: Unconditionally reboot the machine with all defaults
ansible.builtin.reboot:
- name: Reboot a slow machine that might have lots of updates to apply
ansible.builtin.reboot:
reboot_timeout: 3600
- name: Reboot a machine with shutdown command in unusual place
ansible.builtin.reboot:
search_paths:
- '/lib/molly-guard'
- name: Reboot machine using a custom reboot command
ansible.builtin.reboot:
reboot_command: launchctl reboot userspace
boot_time_command: uptime | cut -d ' ' -f 5
- name: Reboot machine and send a message
ansible.builtin.reboot:
msg: "Rebooting machine in 5 seconds"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The number of seconds that elapsed waiting for the system to be rebooted. Returned: always Sample: |
|
true if the machine was rebooted Returned: always Sample: |