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

注意

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

Ansible 2.7 新增

概要 

重启机器，等待它关闭，重新启动并响应命令。
对于 Windows 目标，请改用 ansible.windows.win_reboot 模块。

注意

此模块具有相应的 action 插件。

参数 

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

属性 

属性	支持	描述
action	支持：完全	表示它具有相应的 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: 有关 ansible.windows.win_reboot 模块的官方文档。

示例 

- 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 integer	等待系统重启所经过的秒数。已返回：始终示例： `23`
rebooted boolean	如果机器已重启，则为 true 已返回：始终示例： `true`

作者

Matt Davis (@nitzmahone)
Sam Doran (@samdoran)