ansible.builtin.service 模块 – 管理服务

注意

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

概要 

控制远程主机上的服务。支持的 init 系统包括 BSD init、OpenRC、SysV、Solaris SMF、systemd、upstart。
此模块充当底层服务管理器模块的代理。虽然所有参数都将传递到底层模块，但并非所有模块都支持相同的参数。此文档仅涵盖所有服务管理器模块都支持的模块参数的最小交集。
此模块是多个更具体的服务管理器模块（例如 ansible.builtin.systemd 和 ansible.builtin.sysvinit）的代理。这允许管理异构的机器环境，而无需为每个服务管理器创建特定的任务。要执行的模块由 use 选项确定，该选项默认为 ansible.builtin.setup 发现的服务管理器。如果尚未运行 ansible.builtin.setup，则此模块可能会运行它。
对于 Windows 目标，请改用 ansible.windows.win_service 模块。

注意

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

参数 

参数	注释
arguments 别名：args 字符串	在命令行上提供的其他参数。在具有 systemd 的远程主机上使用时，此设置将被忽略。默认值： `""`
enabled 布尔值	服务是否应在启动时启动。必须至少有一个 state 和 enabled。选项 `false` `true`
name 字符串 / 必需	服务名称。
pattern 字符串	如果服务不响应 status 命令，请命名一个子字符串，以便在 ps 命令的输出中找到该子字符串，以代替状态结果。如果找到该字符串，则假定服务已启动。在具有 systemd 的远程主机上使用时，此设置将被忽略。
runlevel 字符串	仅适用于 OpenRC init 脚本（例如 Gentoo）。此服务所属的运行级别。在具有 systemd 的远程主机上使用时，此设置将被忽略。默认值： `"default"`
sleep 整数	如果要 `restarted` 服务，则在停止和启动命令之间休眠这么多的秒数。这有助于解决在发出停止进程信号后立即退出的行为不当的 init 脚本。并非所有服务管理器都支持 sleep，即在使用 systemd 时，此设置将被忽略。
state 字符串	`started`/`stopped` 是幂等操作，除非必要，否则不会运行命令。 `restarted` 将始终重启服务。 `reloaded` 将始终重新加载。必须至少有一个 state 和 enabled。请注意，如果服务尚未启动，即使您选择的 init 系统通常不会这样做，重新加载也会启动该服务。选项 `"reloaded"` `"restarted"` `"started"` `"stopped"`
use 字符串	服务模块实际上使用特定于系统的模块，通常通过自动检测，此设置可以强制使用特定模块。通常，它使用 ‘ansible_service_mgr’ 事实的值，并在找不到匹配项时回退到旧的 ‘service’ 模块。 “旧服务模块”仍然使用自动检测，并且绝不对应于 `service` 命令。默认值： `"auto"`

属性 

属性	支持	描述
action	支持：完全	指示此模块具有对应的 action 插件，因此可以在控制器上执行部分选项
async	支持：完全	支持与 `async` 关键字一起使用
bypass_host_loop	支持：无	强制执行不针对每个主机执行的“全局”任务，这会绕过每个主机的模板化和串行、限制以及其他循环注意事项条件语句的工作方式与使用 `run_once` 相同，使用的变量将来自第一个可用的主机此操作在锁定步骤策略之外无法正常工作
check_mode	支持：不适用支持取决于调用的底层插件	可以在 check_mode 中运行并返回已更改的状态预测，而无需修改目标，如果不支持，则将跳过该操作。
diff_mode	支持：不适用支持取决于调用的底层插件	当处于 diff 模式时，将返回已更改内容（或在 check_mode 中可能需要更改的内容）的详细信息。
平台	平台：全部支持取决于每个平台上特定插件的可用性，以及是否能够进行事实收集。	可以操作的目标操作系统/系列。

备注 

注意

对于 AIX，可以使用组子系统名称。
service 命令行实用程序不是任何服务管理器系统的一部分，而是一种便利工具。它在不同系统上没有标准的实现，此操作无法直接使用它。尽管在某些情况下可能会使用它，但通常首选检测到的系统服务管理器。

另请参阅 

另请参阅

ansible.windows.win_service: 管理和查询 Windows 服务。

示例 

- name: Start service httpd, if not started
  ansible.builtin.service:
    name: httpd
    state: started

- name: Stop service httpd, if started
  ansible.builtin.service:
    name: httpd
    state: stopped

- name: Restart service httpd, in all cases
  ansible.builtin.service:
    name: httpd
    state: restarted

- name: Reload service httpd, in all cases
  ansible.builtin.service:
    name: httpd
    state: reloaded

- name: Enable service httpd, and not touch the state
  ansible.builtin.service:
    name: httpd
    enabled: yes

- name: Start service foo, based on running process /usr/bin/foo
  ansible.builtin.service:
    name: foo
    pattern: /usr/bin/foo
    state: started

- name: Restart network service for interface eth0
  ansible.builtin.service:
    name: network
    state: restarted
    args: eth0

作者

Ansible 核心团队
Michael DeHaan