ansible.builtin.systemd_service 模块 – 管理 systemd 单元
注意
此模块是 ansible-core
的一部分,包含在所有 Ansible 安装中。在大多数情况下,即使不指定 collections 关键字,也可以使用简短模块名称 systemd_service
。但是,我们建议您使用完全限定集合名称 (FQCN) ansible.builtin.systemd_service
,以便轻松链接到模块文档并避免与其他可能具有相同模块名称的集合冲突。
概要
控制远程主机上的 systemd 单元(服务、定时器等)。
ansible.builtin.systemd 已重命名为 ansible.builtin.systemd_service,以便更好地反映模块的范围。ansible.builtin.systemd 保留为向后兼容的别名。
别名:systemd
要求
以下要求需要在执行此模块的主机上满足。
由 systemd 管理的系统。
参数
参数 |
注释 |
---|---|
在执行任何其他操作之前运行 daemon_reexec 命令,systemd 管理器将序列化管理器状态。 选项
|
|
在执行任何其他操作之前运行 当设置为 选项
|
|
是否覆盖现有符号链接。 选项
|
|
单元的名称。此参数采用要使用的确切一个单元的名称。 当没有给出扩展名时,在 systemd 中默认为 在 chroot 环境中使用时,您始终需要指定带有扩展名的单元名称。例如, |
|
不需同步等待请求的操作完成。排队的作业将继续进行,而无需 Ansible 阻止其完成。 选项
|
|
在给定的服务管理器范围中运行 为了使 systemd 与 用户 dbus 进程通常在正常登录期间启动,而不是在 Ansible 任务运行时启动。否则,您可能会收到“Failed to connect to bus: no such file or directory”错误。 用户必须具有访问权限,通常通过设置 选项
|
|
如果设置,则需要 选项
|
属性
属性 |
支持 |
描述 |
---|---|---|
支持: 完整 |
可以在 check_mode 中运行,并返回已更改的状态预测而无需修改目标,如果不支持,则会跳过该操作。 |
|
支持: 无 |
在 diff 模式下,将返回有关已更改内容(或在 check_mode 中可能需要更改的内容)的详细信息 |
|
平台: posix |
可以对其进行操作的目标操作系统/系列 |
注意
示例
- name: Make sure a service unit is running
ansible.builtin.systemd_service:
state: started
name: httpd
- name: Stop service cron on debian, if running
ansible.builtin.systemd_service:
name: cron
state: stopped
- name: Restart service cron on centos, in all cases, also issue daemon-reload to pick up config changes
ansible.builtin.systemd_service:
state: restarted
daemon_reload: true
name: crond
- name: Reload service httpd, in all cases
ansible.builtin.systemd_service:
name: httpd.service
state: reloaded
- name: Enable service httpd and ensure it is not masked
ansible.builtin.systemd_service:
name: httpd
enabled: true
masked: no
- name: Enable a timer unit for dnf-automatic
ansible.builtin.systemd_service:
name: dnf-automatic.timer
state: started
enabled: true
- name: Just force systemd to reread configs (2.4 and above)
ansible.builtin.systemd_service:
daemon_reload: true
- name: Just force systemd to re-execute itself (2.8 and above)
ansible.builtin.systemd_service:
daemon_reexec: true
- name: Run a user service when XDG_RUNTIME_DIR is not set on remote login
ansible.builtin.systemd_service:
name: myservice
state: started
scope: user
environment:
XDG_RUNTIME_DIR: "/run/user/{{ myuid }}"
返回值
常见的返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典,其中包含从 返回: 成功 示例: |