ansible service 模块

ansible service 模块

概要

• 控制远程主机上的服务。支持的 init 系统包括 BSD init、OpenRC、SysV、Solaris SMF、systemd、upstart。
• 对于 Windows 目标，请改用win_service模块。

参数

parmeter	choices/defaults	comments
dependencies		要为此特定服务设置的服务依赖项列表。这应该是服务名称的列表，而不是服务的显示名称。它通过dependency_action来添加/删除或设置列表中的服务。
dependencies_action	add or remove or set，默认set	与dependency项结合使用，可将依赖项添加到现有服务依赖项中。删除对现有依赖项的依赖项。将依赖项设置为仅替换现有依赖项的列表中的值。
description		要为服务设置的描述。
desktop_interact	yes or no，默认no	如果yes，停止或重新启动具有依赖服务的服务将强制依赖的服务也停止或重新启动。如果no，停止或重启有依赖服务的服务可能会失败。
display_name		要为服务设置的显示名称。
force_dependent_services	yes or no，默认no	如果yes，停止或重新启动具有依赖服务的服务将强制依赖的服务也停止或重新启动。如果no，停止或重启有依赖服务的服务可能会失败。
name		服务的名称,如果只指定了name参数，模块将报告服务是否存在，而不做任何更改。
password		将服务设置为启动的密码。这和username参数必须一起提供。如果指定LocalSystem, NetworkService或LocalService，该字段必须是一个空字符串，不能为空。
path		要为服务设置的可执行文件的路径。
start_mode	auto or delayed or disabled or manual，默认auto	设置服务的启动类型。新创建的服务将默认为auto。
start	absent or paused or started or stopped or restarted，默认stopped	服务的期望状态。started/stopped/absent/paused是幂等操作，除非必要，否则不会运行命令。restarted会重启服务
username		将服务设置为启动的用户名。在使用本地帐户或域帐户时，必须同时提供此参数和password参数。设置为“LocalSystem”表示使用SYSTEM帐户。新创建的服务将默认为LocalSystem。如果使用自定义用户帐户，它必须被授予SeServiceLogonRight才能启动。您可以使用win_user_right模块为您授予该用户权限。

例子

- name: Restart a service
  win_service:
    name: spooler
    state: restarted

- name: Set service startup mode to auto and ensure it is started
  win_service:
    name: spooler
    start_mode: auto
    state: started

- name: Pause a service
  win_service:
    name: Netlogon
    state: paused

- name: Ensure that WinRM is started when the system has settled
  win_service:
    name: WinRM
    start_mode: delayed

# A new service will also default to the following values:
# - username: LocalSystem
# - state: stopped
# - start_mode: auto
- name: Create a new service
  win_service:
    name: service name
    path: C:\temp\test.exe

- name: Create a new service with extra details
  win_service:
    name: service name
    path: C:\temp\test.exe
    display_name: Service Name
    description: A test service description

- name: Remove a service
  win_service:
    name: service name
    state: absent

- name: Check if a service is installed
  win_service:
    name: service name
  register: service_info

# This is required to be set for non-service accounts that need to run as a service
- name: Grant domain account the SeServiceLogonRight user right
  win_user_right:
    name: SeServiceLogonRight
    users:
    - DOMAIN\User
    action: add

- name: Set the log on user to a domain account
  win_service:
    name: service name
    state: restarted
    username: DOMAIN\User
    password: Password

- name: Set the log on user to a local account
  win_service:
    name: service name
    state: restarted
    username: .\Administrator
    password: Password

- name: Set the log on user to Local System
  win_service:
    name: service name
    state: restarted
    username: LocalSystem
    password: ''

- name: Set the log on user to Local System and allow it to interact with the desktop
  win_service:
    name: service name
    state: restarted
    username: LocalSystem
    password: ""
    desktop_interact: yes

- name: Set the log on user to Network Service
  win_service:
    name: service name
    state: restarted
    username: NT AUTHORITY\NetworkService
    password: ''

- name: Set the log on user to Local Service
  win_service:
    name: service name
    state: restarted
    username: NT AUTHORITY\LocalService
    password: ''

- name: Set dependencies to ones only in the list
  win_service:
    name: service name
    dependencies: [ service1, service2 ]

- name: Add dependencies to existing dependencies
  win_service:
    name: service name
    dependencies: [ service1, service2 ]
    dependency_action: add

- name: Remove dependencies from existing dependencies
  win_service:
    name: service name
    dependencies:
    - service1
    - service2
    dependency_action: remove