community.general.shutdown 模块 – 关闭机器

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.shutdown。

community.general 1.1.0 中的新功能

概要 

关闭机器。

注意

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

参数 

参数	注释
delay 整数	关闭前等待的秒数。作为参数传递给 shutdown 命令。在 Linux、macOS 和 OpenBSD 上，这会转换为分钟并向下舍入。如果小于 60，则设置为 0。在 Solaris 和 FreeBSD 上，这将是秒数。默认值： `0`
msg 字符串	关闭前向用户显示的消息。默认值： `"由 Ansible 启动的关闭"`
search_paths 列表 / 元素=路径	在远程计算机上搜索 `shutdown` 命令的路径。只会搜索这些路径以查找 `shutdown` 命令。搜索 `shutdown` 命令时，会忽略远程节点中的 `PATH`。默认值： `["/sbin", "/usr/sbin", "/usr/local/sbin"]`

属性 

属性	支持	描述
action	支持：完全	表示它具有对应的操作插件，因此可以在控制器上执行某些选项。
async	支持：完全	支持与 `async` 关键字一起使用。
check_mode	支持：完全	可以在 `check_mode` 中运行并返回已更改状态预测，而无需修改目标。
diff_mode	支持：无	在差异模式下，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

备注 

注意

在远程节点上搜索 shutdown 命令时，会忽略 PATH。如果默认路径不起作用，请使用 search_paths 指定要搜索的位置。
如果未在 search_paths 中找到 shutdown 命令，则不支持 msg 和 delay 选项，而是模块将尝试通过调用 systemctl shutdown 来关闭系统。

另请参阅 

另请参阅

ansible.builtin.reboot: 重启机器。

示例 

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

返回值 

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

键	描述
shutdown 布尔值	如果机器已关闭，则为 `true`。返回：始终示例： `true`

作者

Matt Davis (@nitzmahone)
Sam Doran (@samdoran)
Amin Vakil (@aminvakil)