Модуль community.windows.win_scheduled_task_stat — Получение информации о запланированных задачах Windows
Примечание
Этот модуль является частью коллекции community.windows (версия 2.3.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 строка | Имя запланированной задачи, для которой требуется получить информацию. Если |
path строка | Путь к папке, в которой находится задача. По умолчанию: |
См. также
См. также
- 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 список / элементы=строка | Список действий. Возвращается: имя указано и задача существует Пример: |
folder_exists булево | Существует ли папка, установленная в пути. Возвращается: всегда Пример: |
folder_task_count целое число | Количество задач, существующих в папке. Возвращается: всегда Пример: |
folder_task_names список / элементы=строка | Список задач, существующих в папке. Возвращается: всегда Пример: |
principal сложное | Сведения о главном субъекте, настроенном для запуска задачи. Возвращается: имя указано и задача существует |
|
display_name строка |
Имя пользователя/группы, отображаемое в пользовательском интерфейсе планировщика задач. Пример: |
|
group_id строка |
Группа, которая запустит задачу. Пример: |
|
id строка |
Идентификатор субъекта. Пример: |
|
logon_type строка |
Метод входа, с которым будет выполняться задача. Пример: |
|
run_level строка |
Уровень прав пользователя, используемых для запуска задачи. Пример: |
|
user_id строка |
Пользователь, который запустит задачу. Пример: |
registration_info сложное | Подробности о регистрации задачи. Возвращается: имя указано и задача существует |
|
author строка |
Автор задачи. Пример: |
|
date строка |
Дата регистрации задачи. Пример: |
|
description строка |
Описание задачи. Пример: |
|
documentation строка |
Документация задачи. Пример: |
|
security_descriptor строка |
Безопасность задачи. Пример: |
|
source строка |
Источник задачи. Пример: |
|
uri строка |
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 |
Является ли задача временной (volatile)? Пример: |
|
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_scheduled_task_stat_module.html