win_service — Управление и запросы служб Windows
Новая в версии 1.7.
Обзор
- Управление и запросы служб Windows.
- Для платформ, не являющихся Windows, используйте модуль service вместо него.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| dependencies (добавлен в 2.3) | Список зависимостей служб для данной службы. Это должен быть список имён служб, а не их дисплейных названий. Это работает путем dependency_action для добавления/удаления или задания служб в этом списке. | |
| dependency_action (добавлен в 2.3) |
| Используется совместно с dependency для добавления зависимостей к существующим зависимостям службы.Удаляет зависимости от существующих зависимостей. Устанавливает зависимости только на значения в списке, заменяя существующие зависимости. |
| description (добавлен в 2.3) | Описание для установки для службы. | |
| desktop_interact bool (добавлен в 2.3) |
| Разрешить пользователю службы взаимодействовать с рабочим столом. Это следует устанавливать только на yes, когда используется имя пользователя LocalSystem. |
| display_name (добавлен в 2.3) | Дисплейное имя для установки для службы. | |
| force_dependent_services bool (добавлен в 2.3) |
| Если yes, остановка или перезапуск службы с зависимыми службами заставит зависимые службы также остановиться или перезапуститься.Если no, остановка или перезапуск службы с зависимыми службами может завершиться ошибкой. |
| name обязательно | Имя службы. Если указан только параметр name, модуль сообщит, существует ли служба или нет, без внесения каких-либо изменений. | |
| password (добавлен в 2.3) | Пароль, который будет использоваться для запуска службы. Этот параметр и параметр username должны быть предоставлены вместе.Если используется LocalSystem, NetworkService или LocalService, это поле должно быть пустой строкой, а не null. | |
| path (добавлен в 2.3) | Путь к исполняемому файлу для установки для службы. | |
| start_mode |
| Установить тип запуска для службы. delayed добавлено в Ansible 2.3 |
| state |
| started/stopped/absent/pause — идемпотентные действия, которые не будут запускать команды, если это не необходимо.restarted всегда перезапустит службу.absent добавлено в Ansible 2.3pause добавлено в Ansible 2.4Только службы, поддерживающие состояние paused, могут быть приостановлены, вы можете проверить возвращаемое значение can_pause_and_continue.Вы можете приостановить только уже запущенную службу. |
| username (добавлен в 2.3) | Имя пользователя для запуска службы. Этот параметр и параметр password должны быть предоставлены вместе, когда используется локальная или доменная учётная запись.Установите LocalSystem, чтобы использовать учётную запись SYSTEM. |
Примечания
Примечание
- Для платформ, не являющихся Windows, используйте модуль service вместо него.
Примеры
- 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
# 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
- 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 bool | успех и служба существует | Возможно ли приостановить и продолжить работу службы. Пример: 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 строка | успех и служба существует | Текущий статус службы. Пример: stopped |
| username строка | успех и служба существует | Имя пользователя, под которым запускается служба. Пример: LocalSystem |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы модуля гарантируют, что не будут вноситься обратные изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как core, что означает, что он поддерживается командой Ansible Core. Подробнее см. Поддержка и техническое обслуживание модулей.
Список других модулей, поддерживаемых командой Ansible Core, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля 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.6/modules/win_service_module.html