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 список		указано имя и существует задача	Список действий. Пример: [{'Путь': 'cmd.exe', 'Тип': 'TASK_ACTION_EXEC', 'Аргументы': '/c echo hi', 'РабочаяПапка': None, 'Идентификатор': None}]
folder_exists логическое значение		всегда	Существует ли папка по указанному пути. Пример: True
folder_task_count целое число		всегда	Количество задач в папке. Пример: 2
folder_task_names список		всегда	Список задач, существующих в папке. Пример: ['Задача 1', 'Задача 2']
principal сложный тип		указано имя и существует задача	Подробная информация о пользователе/группе, настроенной для запуска задачи.
	user_id строка		Пользователь, который запустит задачу. Пример: SERVER\Administrator
	logon_type строка		Способ входа, используемый задачей при запуске. Пример: TASK_LOGON_INTERACTIVE_TOKEN
	display_name строка		Имя пользователя/группы, отображаемое в пользовательском интерфейсе Планировщика задач. Пример: Administrator
	group_id строка		Группа, которая запустит задачу. Пример: BUILTIN\Administrators
	run_level строка		Уровень прав пользователя, используемый для запуска задачи. Пример: TASK_RUNLEVEL_LUA
	id строка		Идентификатор пользователя/группы. Пример: Автор
registration_info сложный тип		указано имя и существует задача	Подробности о регистрации задачи.
	description строка		Описание задачи. Пример: описание задачи
	author строка		Автор задачи. Пример: SERVER\Administrator
	documentation строка		Документация к задаче. Пример: документация к задаче
	uri строка		URI/путь задачи. Пример: \task\имя задачи
	source строка		Источник задачи. Пример: источник
	version строка		Версия задачи. Пример: 1.0
	date строка		Дата регистрации задачи. Пример: 2017-01-01T10:00:00
	security_descriptor строка		Дескриптор безопасности задачи. Пример: дескриптор безопасности
settings сложный тип		указано имя и существует задача	Подробности о параметрах задачи.
	run_only_if_network_available булево значение		Запускать задачу только при наличии сетевого подключения.
	mulitple_instances целое число		Определяет поведение при запуске уже выполняющейся задачи. Пример: 2
	execution_time_limit строка		Лимит времени выполнения задачи. Пример: PT72H
	idle_settings словарь		Настройки задачи в режиме простоя. Пример: {'restart_on_idle': False, 'wait_timeout': 'PT1H', 'idle_duration': 'PT10M', 'stop_on_idle_end': True}
	disallow_start_if_on_batteries булево значение		Не запускать задачу при работе от батареи.
	run_only_id_idle булево значение		Запускать задачу только при бездействии компьютера. Пример: True
	delete_expired_task_after строка		Время ожидания Планировщиком задач перед удалением задачи после истечения срока действия. Пример: PT10M
	network_settings словарь		Сетевые настройки задачи. Пример: {'id': None, 'name': None}
	disallow_start_on_remote_app_session булево значение		Не запускать задачу при удалённой сессии приложения. Пример: True
	restart_interval строка		Интервал, в течение которого Планировщик задач пытается перезапустить задачу. Пример: PT15M

	stop_if_going_on_batteries bool		Указывает, будет ли задача остановлена, если компьютер начнёт работать от батареи. Пример: True
	use_unified_scheduling_engine bool		Указывает, будет ли задача использовать унифицированный движок планирования.
	wake_to_run bool		Указывает, будет ли задача будить компьютер, когда придёт время её выполнения.
	compatibility int		Уровень совместимости задачи Пример: 2
	maintenance_settings str		Настройки обслуживания задачи.
	restart_count int		Количество попыток перезапуска задачи в случае сбоев.
	priority int		Уровень приоритета задачи. Пример: 7
	start_when_available bool		Можно ли запустить задачу в любое время после того, как прошло запланированное время.
	allow_demand_start bool		Можно ли запустить задачу, используя команду «Запуск» или контекстное меню. Пример: True
	allow_hard_terminate bool		Можно ли завершить задачу, используя TerminateProcess. Пример: True
	volatile bool		Является ли задача изменчивой.
	hidden bool		Скрыта ли задача в пользовательском интерфейсе.
	enabled bool		Включена ли задача. Пример: True
state complex		имя указано и задача существует	Подробная информация о состоянии задачи
	last_task_result int		Результаты, возвращённые при последнем запуске задачи. Пример: 267009
	number_of_missed_runs int		Количество пропущенных запусков задачи. Пример: 1
	next_run_time str		Время следующего запланированного запуска задачи. Пример: 2017-09-20T22:50:00
	status str		Статус задачи (запуск, остановка и т. д.). Пример: TASK_STATE_RUNNING
	last_run_time str		Время последнего выполнения зарегистрированной задачи. Пример: 2017-09-20T20:50:00
task_exists boolean		указано имя	Существует ли задача в папке. Пример: True
triggers list		указано имя и задача существует	Список триггеров. Пример: [{'end_boundary': None, 'execution_time_limit': None, 'start_boundary': None, 'enabled': True, 'delay': 'PT15M', 'repetition': {'duration': None, 'interval': None, 'stop_at_duration_end': False}, 'type': 'TASK_TRIGGER_BOOT', 'id': None}, {'end_boundary': None, 'execution_time_limit': None, 'months_of_year': 'june,december', 'start_boundary': '2017-09-20T03:44:38', 'enabled': True, 'days_of_month': '5,15,30', 'random_delay': None, 'run_on_last_day_of_month': True, 'repetition': {'duration': None, 'interval': None, 'stop_at_duration_end': False}, 'type': 'TASK_TRIGGER_MONTHLY', 'id': None}]

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости.

Автор

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.5/modules/win_scheduled_task_stat_module.html