win_service – Управление и запросы служб Windows
Описание
- Управление и запросы служб Windows.
- Для платформ, отличных от Windows, используйте модуль service.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| dependencies список | Список зависимостей службы для настройки. В списке должны быть указаны имена служб, а не их отображаемые названия. Данный параметр dependency_action для добавления/удаления или задания служб в этом списке. | |
| dependency_action строка |
| Используется совместно с dependency для добавления зависимостей к существующим.Удаляет зависимости из существующего списка. Задает зависимости, заменяя существующие только на значения из списка. |
| description строка | Описание, которое нужно задать для службы. | |
| desktop_interact логическое значение |
| Разрешить ли пользователю службы взаимодействовать с рабочим столом. Это должно быть установлено в yes только при использовании имени пользователя LocalSystem. |
| display_name строка | Отображаемое имя службы. | |
| force_dependent_services логическое значение |
| Если yes, остановка или перезапуск службы с зависимыми службами также заставит зависимые службы остановиться или перезапуститься.Если no, остановка или перезапуск службы с зависимыми службами может завершиться неудачей. |
| name строка / обязательно | Имя службы. Если указан только параметр name, модуль сообщит, существует ли служба или нет, не внося никаких изменений. | |
| password строка | Пароль для запуска службы. Этот параметр и параметр username должны быть указаны вместе.Если используется LocalSystem, NetworkService или LocalService, это поле должно быть пустой строкой, а не null. | |
| path строка | Путь к исполняемому файлу для службы. | |
| start_mode строка |
| Установите тип запуска службы. Новая служба по умолчанию будет иметь тип auto. delayed добавлено в Ansible 2.3 |
| state строка |
| Желаемое состояние службы. started/stopped/absent/paused — идемпотентные действия, которые не будут выполнять команды, если это не необходимо.restarted всегда перезапускает службу.absent добавлено в Ansible 2.3paused добавлено в Ansible 2.4Только службы, поддерживающие состояние paused, могут быть приостановлены, вы можете проверить значение возврата can_pause_and_continue. Вы можете приостановить только запущенную службу. Новая служба по умолчанию будет иметь состояние stopped. |
| username строка | Имя пользователя для запуска службы. Этот параметр и параметр password должны быть указаны вместе при использовании локальной или доменной учетной записи.Установите в LocalSystem для использования учетной записи SYSTEM.Новая служба по умолчанию будет использовать учетную запись LocalSystem. Если используется пользовательская учетная запись, она должна иметь право SeServiceLogonRight для запуска. Вы можете использовать модуль win_user_right, чтобы предоставить это право. |
См. также
См. также
- service – Управление службами
- Официальная документация по модулю service.
- win_nssm – Установка службы с помощью NSSM
- Официальная документация по модулю win_nssm.
- win_user_right – Управление правами пользователя Windows
- Официальная документация по модулю 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
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| can_pause_and_continue boolean | успех и служба существует | Указывает, можно ли приостановить и возобновить работу службы. Пример: True |
| depended_by список | успех и служба существует | Список служб, которые зависят от этой службы. |
| dependencies список | успех и служба существует | Список служб, от которых зависит эта служба. |
| description строка | успех и служба существует | Описание службы. Пример: Управляет взаимодействием между компонентами системы. |
| desktop_interact boolean | успех и служба существует | Указывает, разрешен ли текущему пользователю взаимодействие с рабочим столом. |
| display_name строка | успех и служба существует | Имя отображения установленной службы. Пример: CoreMessaging |
| exists boolean | успех | Указывает, существует ли служба. Пример: True |
| name строка | успех и служба существует | Имя или идентификатор службы. Пример: CoreMessagingRegistrar |
| path строка | успех и служба существует | Путь к исполняемому файлу службы. Пример: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork |
| start_mode строка | успех и служба существует | Тип запуска службы. Пример: manual |
| state строка | успех и служба существует | Текущее состояние работы службы. Пример: остановлена |
| username строка | успех и служба существует | Имя пользователя, под которым выполняется служба. Пример: LocalSystem |
Статус
- В этом модуле гарантируются изменения интерфейса, совместимые с предыдущими версиями. [stableinterface]
- Этот модуль поддерживается командой разработчиков Ansible Core. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Chris Hoffman (@chrishoffman)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/win_service_module.html