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) |
| Разрешить пользователю службы взаимодействие с рабочим столом. Устанавливать только в случае использования имени пользователя 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Только службы, поддерживающие состояние 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: 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 список | успех и служба существует | Список служб, зависящих от этой службы. |
| dependencies список | успех и служба существует | Список служб, от которых зависит эта служба. |
| description строка | успех и служба существует | Описание службы. Пример: Управление взаимодействием между компонентами системы. |
| desktop_interact логическое значение | успех и служба существует | Разрешение текущему пользователю взаимодействия с рабочим столом. |
| display_name строка | успех и служба существует | Отображаемое имя установленной службы. Пример: CoreMessaging |
| exists логическое значение | успех | Существует ли служба. Пример: True |
| name строка | успех и служба существует | Имя или идентификатор службы. Пример: CoreMessagingRegistrar |
| path строка | успех и служба существует | Путь к исполняемому файлу службы. Пример: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork |
| start_mode строка | успех и служба существует | Тип запуска службы. Пример: manual |
| state строка | успех и служба существует | Текущий статус службы. Пример: stopped |
| username строка | успех и служба существует | Имя пользователя, под которым выполняется служба. Пример: LocalSystem |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют отсутствие несовместимых изменений интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/win_service_module.html