ansible.windows.win_service_info – Сбор информации о службах Windows
Примечание
Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install ansible.windows.
Для использования в плейбуке укажите: ansible.windows.win_service_info.
Описание
- Сбор информации обо всех или определённых установленных службах Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name строка | Если указано, используется для сопоставления name или display_name службы Windows для получения информации.Может содержать подстановочный символ для сопоставления нескольких служб, но подстановочный символ будет сопоставляться только с name службы, а не с display_name.Если опущено, будут возвращены все службы. |
См. также
См. также
- ansible.windows.win_service
-
Официальная документация по модулю ansible.windows.win_service.
Примеры
- name: Get info for all installed services
ansible.windows.win_service_info:
register: service_info
- name: Get info for a single service
ansible.windows.win_service_info:
name: WinRM
register: service_info
- name: Get info for a service using its display name
ansible.windows.win_service_info:
name: Windows Remote Management (WS-Management)
- name: Find all services that start with 'win'
ansible.windows.win_service_info:
name: win*
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| exists boolean | всегда | Указывает, были ли найдены какие-либо службы на основе указанных критериев. Пример: True | |||
| services список / элементы=словарь | всегда | Список найденных служб на основе критериев. Будет пустым списком, если службы не были найдены. | |||
| checkpoint целое число | успех | Значение контрольной точки, которое служба периодически увеличивает, чтобы сообщить о своем прогрессе. | |||
| controls_accepted список / элементы=строка | успех | Список команд, которые служба может принять. Общие команды — stop, pause_continue, shutdown. Пример: ['stop', 'shutdown'] | |||
| dependencies список / элементы=строка | успех | Список служб по их name, от которых зависит эта служба.Пример: ['HTTP', 'RPCSS'] | |||
| dependency_of список / элементы=строка | успех | Список служб по их name, которые зависят от этой службы.Пример: ['upnphost', 'WMPNetworkSvc'] | |||
| description строка | успех | Описание службы. Пример: Пример описания службы Windows. | |||
| desktop_interact boolean | успех | Возможность службы взаимодействовать с рабочим столом, применимо только для служб, работающих как SYSTEM. | |||
| display_name строка | успех | Имя для отображения, используемое SCM для идентификации службы. Пример: Удаленное управление Windows (WS-Management) | |||
| error_control строка | успех | Действие, которое необходимо предпринять, если служба не может быть запущена. Общие значения — critical, ignore, normal, severe.Пример: normal | |||
| failure_action_on_non_crash_failure boolean | успех | Управление запуском действий по ошибке в зависимости от того, как была остановлена служба. | |||
| failure_actions список / элементы=словарь | успех | Список действий по ошибке для выполнения в случае сбоя. | |||
| delay_ms целое число | успех | Время ожидания в миллисекундах перед выполнением указанного действия. Пример: 120000 | |||
| type строка | успех | Действие, которое будет выполнено. Общие значения — none, reboot, restart, run_command.Пример: run_command | |||
| failure_command строка | успех | Командная строка, которая будет выполнена при срабатывании действия по ошибке run_command.Пример: runme.exe | |||
| failure_reboot_msg строка | успех | Сообщение, которое будет отображено пользователям сервера перед перезагрузкой при срабатывании действия по ошибке reboot.Пример: Служба не выполнена, перезагружается хост. | |||
| failure_reset_period_sec целое число | успех | Время в секундах, после которого счетчик ошибок будет сброшен к нулю. Пример: 86400 | |||
| launch_protection строка | успех | Тип защиты службы. Общие значения — none, windows, windows_light, или antimalware_light.Пример: none | |||
| load_order_group строка | успех | Имя группы порядка загрузки, к которой принадлежит служба. Будет пустой строкой, если она не принадлежит ни к какой группе. Пример: Моя группа | |||
| name строка | успех | Имя службы. Пример: WinRM | |||
| path строка | успех | Путь к бинарному файлу службы и любым аргументам, используемым при запуске службы. Часть бинарного файла может быть заключена в кавычки, чтобы убедиться, что пробелы в пути не интерпретируются как аргументы. Пример: C:\Windows\System32\svchost.exe -k netsvcs -p | |||
| pre_shutdown_timeout_ms целое число | успех | Значение таймаута предварительного завершения в миллисекундах. Пример: 10000 | |||
| preferred_node целое число | успех | Номер узла для предпочтительного узла. Будет null, если у хоста Windows нет конфигурации NUMA. | |||
| process_id целое число | успех | Идентификатор процесса работающей службы. Пример: 5135 | |||
| required_privileges список / элементы=строка | успех | Список привилегий, которые необходимы службе и будут использованы ею. Пример: ['SeBackupPrivilege', 'SeRestorePrivilege'] | |||
| service_exit_code целое число | успех | Код ошибки, специфичный для службы, который устанавливается во время запуска или остановки службы. | |||
| service_flags список / элементы=строка | успех | Предоставляет дополнительную информацию о поведении работающей службы. В настоящее время единственный устанавливаемый флаг — runs_in_system_process. Пример: ['runs_in_system_process'] | |||
| service_type строка | успех | Тип службы. Общие типы — win32_own_process, win32_share_process, user_own_process, user_share_process, kernel_driver.Пример: win32_own_process | |||
| sid_info строка | успех | Поведение, определяющее, как генерируется маркер доступа службы и как идентификатор службы добавляется в маркер. Общие значения — none, restricted, или unrestricted.Пример: none | |||
| start_mode строка | успех | Режим запуска службы. Общие значения — auto, manual, disabled, delayed.Пример: auto | |||
| state строка | успех | Текущее состояние работы службы. Общие значения — stopped, start_pending, stop_pending, started, continue_pending, pause_pending, paused.Пример: started | |||
| triggers список / элементы=словарь | успех | Список триггеров, определенных для службы. | |||
| action строка | успех | Действие, которое будет выполнено при срабатывании триггера, может быть start_service или stop_service.Пример: start_service | |||
| data_items список / элементы=словарь | успех | Список элементов данных триггера, содержащих данные, специфичные для триггера. Триггер может содержать 0 или несколько элементов данных. | |||
| data сложное | успех | Значение элемента данных триггера. Может быть строкой, списком строк, целым числом или строкой base64 двоичных данных. Пример: именованная труба | |||
| Тип строка | успех | Тип data для триггера.Общие значения — string, binary, level, keyword_any, или keyword_all.Пример: строка | |||
| подтип строка | успех | Подтип события триггера, специфичный для каждого type.Общие значения — named_pipe_event, domain_join, domain_leave, firewall_port_open, и другие. | |||
| guid_подтипа строка | успех | GUID, представляющий подтип триггера. Пример: 1ce20aba-9851-4421-9430-1ddeb766e809 | |||
| Тип строка | успех | Тип события триггера. Общие значения — custom, rpc_interface_event, domain_join, group_policy, и другие.Пример: domain_join | |||
| имя_пользователя строка | успех | Имя пользователя, используемое для запуска службы. Может быть null для пользовательских служб и определённых служб драйверов. Пример: NT AUTHORITY\SYSTEM | |||
| wait_hint_мс целое число | успех | Приблизительное время в миллисекундах, необходимое для операций ожидания запуска, остановки, приостановки или продолжения. | |||
| win32_код_ошибки целое число | успех | Код ошибки, возвращённый двоичным файлом службы после её остановки. Если установлено значение 1066, то ошибка, специфичная для службы, возвращается при service_exit_code. | |||
Авторы
- Jordan Borean (@jborean93)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_service_info_module.html
