win_service – Управление и запрос служб Windows
Описание
- Управление и запрос служб Windows.
- Для платформ, отличных от Windows, используйте модуль service вместо этого.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| dependencies список добавлен в 2.3 | Список зависимостей службы для настройки. Список должен содержать имена служб, а не их отображаемые имена. Это работает, dependency_action добавляя/удаляя или устанавливая службы в этом списке. | |
| dependency_action строка добавлен в 2.3 |
| Используется вместе с dependency для добавления зависимостей к существующим зависимостям службы.Удаляет зависимости из существующих зависимостей. Устанавливает зависимости только на значения в списке, заменяя существующие зависимости. |
| description строка добавлен в 2.3 | Описание для настройки службы. | |
| desktop_interact логическое добавлен в 2.3 |
| Разрешить пользователю службы взаимодействовать с рабочим столом. Это значение должно быть установлено на yes только при использовании имени пользователя LocalSystem. |
| display_name строка добавлен в 2.3 | Отображаемое имя для настройки службы. | |
| force_dependent_services логическое добавлен в 2.3 |
| Если yes, остановка или перезапуск службы с зависимыми службами заставит зависимые службы также остановиться или перезапуститься.Если no, остановка или перезапуск службы с зависимыми службами может завершиться ошибкой. |
| name строка / обязательно | Имя службы. Если указан только параметр name, модуль сообщит, существует ли служба или нет, без внесения каких-либо изменений. | |
| password строка добавлен в 2.3 | Пароль для запуска службы. Этот и параметр username должны быть указаны вместе.Если указываете LocalSystem, NetworkService или LocalService, это поле должно быть пустой строкой, а не null. | |
| path строка добавлен в 2.3 | Путь к исполняемому файлу для настройки службы. | |
| 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 строка добавлен в 2.3 | Имя пользователя для запуска службы. Этот и параметр password должны быть указаны вместе при использовании локальной или доменной учетной записи.Установите значение LocalSystem для использования учетной записи SYSTEM.Нововведенная служба по умолчанию будет использовать LocalSystem. |
См. также
См. также
- service – Управление службами
- Официальная документация по модулю service.
- win_nssm – Установка службы с помощью NSSM
- Официальная документация по модулю win_nssm.
Примеры
- 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
- 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]
Поддержка 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.8/modules/win_service_module.html