Модуль community.windows.win_scheduled_task_stat — получение информации о запланированных задачах Windows
Примечание
Этот модуль входит в коллекцию community.windows (версия 3.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.windows.
Чтобы использовать её в плейбуке, укажите: community.windows.win_scheduled_task_stat.
Обзор
- Возвращает сведения о том, существует ли папка и задача.
- Возвращает имена задач в указанной папке.
- Используйте community.windows.win_scheduled_task для настройки запланированной задачи.
Параметры
Параметр | Комментарии |
|---|---|
name string | Имя запланированной задачи, сведения о которой нужно получить. Если параметр |
path string | Путь к папке, в которой находится задача. Значение по умолчанию: |
См. также
См. также
- 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 list / elements=string | Список действий. Возвращается: указано имя и задача существует Пример: |
folder_exists boolean | Существует ли папка, указанная в пути. Возвращается: всегда Пример: |
folder_task_count integer | Количество задач в папке. Возвращается: всегда Пример: |
folder_task_names list / elements=string | Список задач в папке. Возвращается: всегда Пример: |
principal complex | Сведения о субъекте, настроенном для запуска задачи. Возвращается: указано имя и задача существует |
|
display_name string |
Имя пользователя/группы, отображаемое в интерфейсе планировщика заданий. Пример: |
|
group_id string |
Группа, от имени которой будет выполняться задача. Пример: |
|
id string |
Идентификатор субъекта. Пример: |
|
logon_type string |
Метод входа в систему, используемый для запуска задачи. Пример: |
|
run_level string |
Уровень прав пользователя, используемых для запуска задачи. Пример: |
|
user_id string |
Пользователь, от имени которого будет выполняться задача. Пример: |
registration_info complex | Сведения о регистрации задачи. Возвращается: указано имя и задача существует |
|
author string |
Автор задачи. Пример: |
|
date string |
Дата регистрации задачи. Пример: |
|
description string |
Описание задачи. Пример: |
|
documentation string |
Документация задачи. Пример: |
|
security_descriptor string |
Дескриптор безопасности задачи. Пример: |
|
source string |
Источник задачи. Пример: |
|
uri string |
URI/путь задачи. Пример: |
|
version string |
Версия задачи. Пример: |
settings complex | Сведения о параметрах задачи. Возвращается: указано имя и задача существует |
|
allow_demand_start boolean |
Можно ли запустить задачу с помощью команды «Выполнить» в контекстном меню. Пример: |
|
allow_hard_terminate boolean |
Можно ли завершить задачу с помощью TerminateProcess. Пример: |
|
compatibility integer |
Уровень совместимости задачи Пример: |
|
delete_expired_task_after string |
Время, которое планировщик заданий будет ожидать перед удалением задачи после истечения срока её действия. Пример: |
|
disallow_start_if_on_batteries boolean |
Не запускать ли задачу, если компьютер работает от аккумулятора. Пример: |
|
disallow_start_on_remote_app_session boolean |
Не запускать ли задачу во время сеанса удалённого приложения. Пример: |
|
enabled boolean |
Включена ли задача. Пример: |
|
execution_time_limit string |
Время, отведённое на выполнение задачи. Пример: |
|
boolean |
Скрыта ли задача в интерфейсе. Пример: |
|
idle_settings dictionary |
Параметры простоя задачи. Пример: |
|
maintenance_settings string |
Параметры обслуживания задачи. |
|
mulitple_instances integer |
Определяет поведение при запуске уже выполняющейся задачи. Пример: |
|
network_settings dictionary |
Параметры сети задачи. Пример: |
|
priority integer |
Уровень приоритета задачи. Пример: |
|
restart_count integer |
Количество попыток перезапустить задачу в случае сбоя. Пример: |
|
restart_interval string |
Время, в течение которого планировщик заданий будет пытаться перезапустить задачу. Пример: |
|
run_only_id_idle boolean |
Будет ли задача выполняться, если компьютер находится в состоянии простоя. Пример: |
|
run_only_if_network_available boolean |
Будет ли задача выполняться только при наличии сети. Пример: |
|
start_when_available boolean |
Можно ли запустить задачу в любое время после наступления запланированного срока её запуска. Пример: |
|
stop_if_going_on_batteries boolean |
Будет ли задача остановлена, если компьютер перейдёт на питание от аккумулятора. Пример: |
|
use_unified_scheduling_engine boolean |
Будет ли задача использовать унифицированный механизм планирования. Пример: |
|
volatile boolean |
Является ли задача временной. Пример: |
|
wake_to_run boolean |
Будет ли задача выводить компьютер из спящего режима к моменту запуска. Пример: |
state complex | Сведения о состоянии задачи Возвращается: указано имя и задача существует |
|
last_run_time string |
Время последнего запуска зарегистрированной задачи. Пример: |
|
last_task_result integer |
Результат последнего запуска задачи. Пример: |
|
next_run_time string |
Время следующего запланированного запуска задачи. Пример: |
|
number_of_missed_runs integer |
Количество пропущенных запланированных запусков задачи. Пример: |
|
status string |
Состояние задачи: выполняется, остановлена и т. д. Пример: |
task_exists boolean | Существует ли задача в папке. Возвращается: указано имя Пример: |
triggers list / elements=string | Список триггеров. Возвращается: указано имя и задача существует Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/windows/win_scheduled_task_stat_module.html