win_service – Управление и запросы служб Windows
Новая версия с 1.7.
Описание
- Управление и запросы служб 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 - |
| Установка типа запуска службы. delayed добавлен в Ansible 2.3 |
| state - |
| started/stopped/absent/pause - идемпотентные действия, которые не будут запускать команды, если это не необходимо.restarted всегда будет перезапускать службу.absent добавлен в Ansible 2.3pause был добавлен в Ansible 2.4Только службы, поддерживающие состояние приостановки, могут быть приостановлены, вы можете проверить возвращаемое значение 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 булево | успех и служба существует | Возможно ли приостановить и продолжить работу службы. Пример: True |
| depended_by список | успех и служба существует | Список служб, которые зависят от этой службы. |
| dependencies список | успех и служба существует | Список служб, от которых зависит эта служба. |
| description строка | успех и служба существует | Описание службы. Пример: Управление взаимодействием между компонентами системы. |
| desktop_interact булево | успех и служба существует | Разрешено ли текущему пользователю взаимодействовать с рабочим столом. |
| display_name строка | успех и служба существует | Отображаемое имя установленной службы. Пример: CoreMessaging |
| exists булево | успех | Существует ли служба или нет. Пример: True |
| name строка | успех и служба существует | Имя или идентификатор службы. Пример: CoreMessagingRegistrar |
| path строка | успех и служба существует | Путь к исполняемому файлу службы. Пример: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork |
| start_mode строка | успех и служба существует | Тип запуска службы. Пример: вручную |
| 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.7/modules/win_service_module.html