win_scheduled_task_stat – Получение информации о запланированных задачах Windows

Новая версия 2.5.

Описание
Параметры
См. также
Примеры
Значения возврата
Статус

Описание

Возвращает информацию о существовании папки и задачи.
Возвращает имена задач в указанной папке.
Используйте win_scheduled_task для настройки запланированной задачи.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
name строка		Имя запланированной задачи, для которой требуется информация. Если `name` задано и существует, вернёт информацию о самой задаче.
path строка	По умолчанию: "\\"	Путь к папке, где находится задача.

См. также

win_scheduled_task – Управление запланированными задачами: Официальная документация модуля win_scheduled_task.

Примеры

- 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 булево		Задача скрыта в интерфейсе?

END_OF_DOCUMENT_MARKER

	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. [сообщество]

Авторы

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