ansible.builtin.reboot 模块 – 重启机器

注意

此模块是 ansible-core 的一部分，并包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，您也可以使用短模块名称 reboot。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.reboot，以便轻松链接到模块文档并避免与其他可能具有相同模块名称的集合冲突。

Ansible 2.7 中的新功能

概要

• 重启机器，等待其关闭、重新启动并响应命令。

• 对于 Windows 目标，请改用 ansible.windows.win_reboot 模块。

注意

此模块具有相应的 操作插件。

参数

参数	注释
boot_time_command 字符串 在 ansible-base 2.10 中添加	运行的命令，该命令返回一个唯一的字符串，指示系统上次启动的时间。 如果将其设置为每次运行都有不同输出的命令，则任务将失败。 默认值： "cat /proc/sys/kernel/random/boot_id"
connect_timeout 整数	在再次尝试之前，等待与受管主机成功连接的最大秒数。 如果未指定，则使用底层连接插件的默认设置。
msg 字符串	在重启之前向用户显示的消息。 默认值： "Ansible 启动的重启"
post_reboot_delay 整数	在重启命令成功后，等待尝试验证系统是否成功重启的秒数。 如果您想等待某些东西稳定下来，尽管您的连接已经工作，这很有用。 默认值： 0
pre_reboot_delay 整数	重启前等待的秒数。作为参数传递给重启命令。 在 Linux、macOS 和 OpenBSD 上，这会转换为分钟并向下舍入。如果小于 60，则设置为 0。 在 Solaris 和 FreeBSD 上，这将是秒。 默认值： 0
reboot_command 字符串 在 ansible-core 2.11 中添加	运行的命令，该命令重启系统，包括传递给该命令的任何参数。 可以是命令的绝对路径，也可以只是命令名称。如果未给出命令的绝对路径，则将在目标系统上搜索 search_paths 以找到绝对路径。 这将导致忽略 pre_reboot_delay、 post_reboot_delay 和 msg。 默认值： “[根据目标操作系统确定]”
reboot_timeout 整数	等待机器重启并响应测试命令的最大秒数。 此超时时间是针对重启验证和测试命令成功单独评估的，因此模块的最大执行时间是此时间的两倍。 默认值： 600
search_paths 列表 / 元素=字符串 在 Ansible 2.8 中添加	在远程计算机上搜索 shutdown 命令的路径。 仅会搜索这些路径以查找 shutdown 命令。在远程节点上搜索 shutdown 命令时，会忽略 PATH。 默认值： ["/sbin", "/bin", "/usr/sbin", "/usr/bin", "/usr/local/sbin"]
test_command 字符串	在重启的主机上运行的命令，并期望成功，以确定机器已准备好执行进一步的任务。 默认值： "whoami"

属性

属性	支持	描述
action	支持： 完全支持	表示它有一个对应的操作插件，因此某些选项的部分可以在控制器上执行
async	支持： 不支持	支持与 async 关键字一起使用
bypass_host_loop	支持： 不支持	强制执行一个“全局”任务，该任务不按主机执行，这绕过了按主机模板化以及串行、节流和其他循环考虑。 条件语句将像使用 run_once 一样工作，使用的变量将来自第一个可用的主机。 此操作在锁定步策略之外无法正常工作。
check_mode	支持： 完全支持	可以在 check_mode 下运行，并返回已更改的状态预测，而无需修改目标，如果不支持，则跳过该操作。
diff_mode	支持： 不支持	在 diff 模式下，将返回有关已更改（或可能需要在 check_mode 下更改）的详细信息。
platform	平台： posix	可以操作的目标操作系统/系列

注意事项

注意

• 当搜索 shutdown 命令时，远程节点上的 PATH 被忽略。如果默认路径不起作用，请使用 search_paths 指定要搜索的位置。

另请参阅

另请参阅

ansible.windows.win_reboot

重启 Windows 机器。

示例

- 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"

返回值

常用返回值记录在 此处，以下是此模块独有的字段

键	描述
elapsed 整数	等待系统重启所经过的秒数。 返回值： 始终返回 示例： 23
rebooted 布尔值	如果机器已重启，则为 true 返回值： 始终返回 示例： true

作者

• Matt Davis (@nitzmahone)

• Sam Doran (@samdoran)

集合链接

• 问题跟踪器
• 存储库 (源代码)
• 沟通