win_scheduled_task_stat – Получение информации о запланированных задачах Windows
Новая в версии 2.5.
Описание
- Вернет, существует ли папка и задача.
- Возвращает имена задач в указанной папке.
- Если
nameзадано и существует, вернёт информацию о самой задаче. - Используйте win_scheduled_task для настройки запланированной задачи.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name - | Имя запланированной задачи, для которой требуется информация. | |
| path - | По умолчанию: "\\" | Путь к папке, где находится задача. |
Примеры
- name: get information about a folder
win_scheduled_task_stat:
path: \folder name
register: task_folder_stat
- name: get information about a task in the root folder
win_scheduled_task_stat:
name: task name
register: task_stat
- name: get information about a task in a custom folder
win_scheduled_task_stat:
path: \folder name
name: task name
register: task_stat
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| actions список | указано имя и существует задача | Список действий. Пример: [{'Arguments': '/c echo hi', 'Id': None, 'Path': 'cmd.exe', 'Type': 'TASK_ACTION_EXEC', 'WorkingDirectory': None}] | |
| folder_exists логическое | всегда | Существует ли папка по заданному пути. Пример: True | |
| folder_task_count целое число | всегда | Количество задач в папке. Пример: 2 | |
| folder_task_names список | всегда | Список задач, существующих в папке. Пример: ['Задача 1', 'Задача 2'] | |
| principal сложный тип | указано имя и существует задача | Подробная информация о субъекте, настроенном для запуска задачи. | |
| display_name строка | Имя пользователя/группы, отображаемое в пользовательском интерфейсе Планировщика задач. Пример: Администратор | ||
| group_id строка | Группа, которая запустит задачу. Пример: BUILTIN\Администраторы | ||
| id строка | Идентификатор субъекта. Пример: Автор | ||
| logon_type строка | Способ входа, с которым будет выполняться задача. Пример: TASK_LOGON_INTERACTIVE_TOKEN | ||
| run_level строка | Уровень прав пользователя, используемых для запуска задачи. Пример: TASK_RUNLEVEL_LUA | ||
| user_id строка | Пользователь, который запустит задачу. Пример: SERVER\Администратор | ||
| registration_info сложный тип | указано имя и существует задача | Информация о регистрации задачи. | |
| author строка | Автор задачи. Пример: SERVER\Администратор | ||
| date строка | Дата регистрации задачи. Пример: 2017-01-01T10:00:00 | ||
| description строка | Описание задачи. Пример: описание задачи | ||
| documentation строка | Документация задачи. Пример: документация задачи | ||
| security_descriptor строка | Описание безопасности задачи. Пример: описание безопасности | ||
| source строка | Источник задачи. Пример: источник | ||
| uri строка | URI/путь задачи. Пример: \task\имя_задачи | ||
| version строка | Версия задачи. Пример: 1.0 | ||
| settings сложный тип | указано имя и существует задача | Подробная информация о параметрах задачи. | |
| allow_demand_start логическое | Можно ли запустить задачу, используя команду Выполнить или контекстное меню. Пример: True | ||
| allow_hard_terminate логическое | Можно ли завершить задачу с помощью TerminateProcess. Пример: True | ||
| compatibility целое число | Уровень совместимости задачи. Пример: 2 | ||
| delete_expired_task_after строка | Время, которое Планировщик задач ожидает перед удалением задачи после истечения срока действия. Пример: PT10M | ||
| disallow_start_if_on_batteries логическое | Запретить запуск задачи при работе от батареи. | ||
| disallow_start_on_remote_app_session логическое | Запретить запуск задачи при удалённой сессии. Пример: True | ||
| enabled логическое | Включена ли задача. Пример: True | ||
| execution_time_limit строка | Ограничение времени выполнения задачи. Пример: PT72H | ||
| hidden логическое | Скрыта ли задача в пользовательском интерфейсе. | ||
| idle_settings словарь | Параметры задачи при бездействии. Пример: {'idle_duration': 'PT10M', 'restart_on_idle': False, 'stop_on_idle_end': True, 'wait_timeout': 'PT1H'} | ||
| maintenance_settings строка | Параметры обслуживания задачи. | ||
| mulitple_instances целое число | Указывает поведение при запуске задачи, которая уже выполняется. Пример: 2 | ||
| network_settings словарь | Настройки сети задачи. Пример: {'id': None, 'name': None} | ||
| priority целое число | Уровень приоритета задачи. Пример: 7 | ||
| restart_count целое число | Количество попыток перезапуска задачи при ошибках. | ||
| restart_interval строка | Время, которое планировщик задач будет пытаться перезапустить задачу. Пример: PT15M | ||
| run_only_id_idle логическое значение | Будет ли задача выполняться, если компьютер находится в состоянии простоя. Пример: True | ||
| run_only_if_network_available логическое значение | Будет ли задача выполняться только при наличии сети. | ||
| start_when_available логическое значение | Может ли задача начаться в любое время после того, как прошло запланированное время. | ||
| stop_if_going_on_batteries логическое значение | Будет ли задача остановлена, если компьютер перейдет на питание от батареи. Пример: True | ||
| use_unified_scheduling_engine логическое значение | Будет ли задача использовать унифицированный движок планирования. | ||
| volatile логическое значение | Является ли задача изменчивой. | ||
| wake_to_run логическое значение | Будет ли задача будить компьютер, когда пришло время запустить задачу. | ||
| state сложное | указано имя и существует задача | Подробная информация о состоянии задачи | |
| last_run_time строка | Время последнего запуска зарегистрированной задачи. Пример: 2017-09-20T20:50:00 | ||
| last_task_result целое число | Результаты, возвращенные при последнем запуске задачи. Пример: 267009 | ||
| next_run_time строка | Время следующего запланированного запуска задачи. Пример: 2017-09-20T22:50:00 | ||
| number_of_missed_runs целое число | Количество раз, когда задача пропустила запланированный запуск. Пример: 1 | ||
| status строка | Состояние задачи, например, выполняется, остановлена и т. д. Пример: TASK_STATE_RUNNING | ||
| task_exists логическое значение | указано имя | Существует ли задача в папке. Пример: True | |
| triggers список | указано имя и существует задача | Список триггеров. Пример: [{'delay': 'PT15M', 'enabled': True, 'end_boundary': None, 'execution_time_limit': None, 'id': None, 'repetition': {'duration': None, 'interval': None, 'stop_at_duration_end': False}, 'start_boundary': None, 'type': 'TASK_TRIGGER_BOOT'}, {'days_of_month': '5,15,30', 'enabled': True, 'end_boundary': None, 'execution_time_limit': None, 'id': None, 'months_of_year': 'june,december', 'random_delay': None, 'repetition': {'duration': None, 'interval': None, 'stop_at_duration_end': False}, 'run_on_last_day_of_month': True, 'start_boundary': '2017-09-20T03:44:38', 'type': 'TASK_TRIGGER_MONTHLY'}] | |
Статус
- Этому модулю не гарантируется обратная совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/win_scheduled_task_stat_module.html
