community.windows.win_scheduled_task_stat – Получение информации о запланированных задачах Windows
Примечание
Этот плагин входит в состав коллекции community.windows (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.windows.
Для использования в playbook укажите: community.windows.win_scheduled_task_stat.
Обзор
- Определяет, существует ли папка и задача.
- Возвращает имена задач в указанной папке.
- Используйте community.windows.win_scheduled_task для настройки запланированной задачи.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name string | Имя запланированной задачи, для которой требуется получить информацию. Если name установлено и существует, вернёт информацию о самой задаче. | |
| path string | По умолчанию: "\\" | Путь к папке, где находится задача. |
См. также
См. также
- community.windows.win_scheduled_task
-
Официальная документация по модулю community.windows.win_scheduled_task.
Примеры
- name: Get information about a folder
community.windows.win_scheduled_task_stat:
path: \folder name
register: task_folder_stat
- name: Get information about a task in the root folder
community.windows.win_scheduled_task_stat:
name: task name
register: task_stat
- name: Get information about a task in a custom folder
community.windows.win_scheduled_task_stat:
path: \folder name
name: task name
register: task_stat
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| actions список / элементы=строка | указано имя и задача существует | Список действий. Пример: [{'Аргументы': '/c echo hi', 'Идентификатор': None, 'Путь': 'cmd.exe', 'Тип': 'TASK_ACTION_EXEC', 'Рабочая папка': 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 string | Время следующего запуска задачи. Пример: 2017-09-20T22:50:00 | ||
| number_of_missed_runs integer | Количество пропущенных запусков задачи. Пример: 1 | ||
| status string | Статус задачи, например, запуск, остановка и т.д. Пример: TASK_STATE_RUNNING | ||
| task_exists boolean | name is specified | Существует ли задача в папке. Пример: True | |
| triggers list / elements=string | name is specified and task exists | Список триггеров. Пример: [{'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'}] | |
Авторы
- Jordan Borean (@jborean93)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_scheduled_task_stat_module.html
