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 int | Указывает поведение при запуске задачи, которая уже выполняется. Пример: 2 | ||
| network_settings dictionary | Настройки сети задачи. Пример: {'id': None, 'name': None} | ||
| priority int | Уровень приоритета задачи. Пример: 7 | ||
| restart_count int | Количество попыток перезапуска задачи при ошибках. | ||
| restart_interval str | Время, в течение которого планировщик задач будет пытаться перезапустить задачу. Пример: PT15M | ||
| run_only_id_idle bool | Выполнять задачу только при бездействии компьютера. Пример: True | ||
| run_only_if_network_available bool | Выполнять задачу только при наличии сетевого подключения. | ||
| start_when_available bool | Разрешить запуск задачи в любое время после истечения запланированного времени. | ||
| stop_if_going_on_batteries bool | Остановить задачу, если компьютер переключился на питание от батареи. Пример: True | ||
| use_unified_scheduling_engine bool | Использовать объединённый движок планирования. | ||
| volatile bool | Является ли задача изменчивой. | ||
| wake_to_run bool | Разрешить пробуждение компьютера для выполнения задачи. | ||
| state complex | name is specified and task exists | Подробная информация о состоянии задачи | |
| last_run_time str | Время последнего запуска зарегистрированной задачи. Пример: 2017-09-20T20:50:00 | ||
| last_task_result int | Результаты, возвращённые при последнем запуске задачи. Пример: 267009 | ||
| next_run_time str | Время следующего запланированного запуска задачи. Пример: 2017-09-20T22:50:00 | ||
| number_of_missed_runs int | Количество пропущенных запусков задачи. Пример: 1 | ||
| status str | Состояние задачи (выполняется, остановлена и т.д.). Пример: TASK_STATE_RUNNING | ||
| task_exists boolean | name is specified | Существует ли задача в указанной папке. Пример: True | |
| triggers list | 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'}] | |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/win_scheduled_task_stat_module.html
