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 строка		Имя запланированной задачи для получения информации. Если `name` установлено и существует, вернёт информацию о самой задаче.
path строка	По умолчанию: "\\"	Путь к папке, в которой находится задача.

См. также

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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_scheduled_task_stat_module.html