win_service - Управление службами Windows
Новая версия 1.7.
Описание
- Управление службами Windows.
- Для платформ, отличных от Windows, используйте модуль service вместо этого.
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| dependencies (добавлен в 2.3)
| нет | Список зависимостей службы для установки. Должен содержать имена служб, а не их отображаемые названия. Это работает путем dependency_action для добавления/удаления или установки служб в этом списке. | ||
| dependency_action (добавлен в 2.3)
| нет | set |
| Используется совместно с dependency для добавления зависимостей к существующим зависимостям службы.Удаление зависимостей из существующих зависимостей. Установка зависимостей только на значения в списке, заменяя существующие зависимости. |
| description (добавлен в 2.3)
| нет | Описание, которое нужно установить для службы. | ||
| desktop_interact (добавлен в 2.3)
| нет | Разрешить пользователю службы взаимодействовать с рабочим столом. Устанавливается только в значение true при использовании имени пользователя LocalSystem. | ||
| display_name (добавлен в 2.3)
| нет | Отображаемое имя, устанавливаемое для службы. | ||
| force_dependent_services (добавлен в 2.3)
| нет | Если True, остановка или перезапуск службы с зависимыми службами заставит зависимые службы также остановиться или перезапуститься. Если False, остановка или перезапуск службы с зависимыми службами может завершиться ошибкой. | ||
| 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 аргумент должны быть указаны вместе. |
Примеры
- 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: True
- 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 | Список служб, зависящих от данной службы. | при успехе и наличии службы | список | False |
| dependencies | Список служб, от которых зависит данная служба. | при успехе и наличии службы | список | False |
| description | Описание службы. | при успехе и наличии службы | строка | Управление коммуникацией между системными компонентами. |
| desktop_interact | Разрешено ли текущему пользователю взаимодействовать с рабочим столом. | при успехе и наличии службы | boolean | False |
| display_name | Отображаемое имя установленной службы. | при успехе и наличии службы | строка | CoreMessaging |
| exists | Существует ли служба. | при успехе | boolean | True |
| name | Имя или идентификатор службы. | при успехе и наличии службы | строка | CoreMessagingRegistrar |
| path | Путь к исполняемому файлу службы. | при успехе и наличии службы | строка | C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork |
| start_mode | Тип запуска службы. | при успехе и наличии службы | строка | manual |
| state | Текущее состояние работы службы. | при успехе и наличии службы | строка | stopped |
| username | Имя пользователя, под которым запускается служба. | при успехе и наличии службы | строка | LocalSystem |
Примечания
Примечание
- Для платформ, отличных от Windows, используйте модуль service вместо этого.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые изменения в интерфейс.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке данного модуля компанией Red Hat обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочтите Информация о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_service_module.html