Spec-Zone.ru › Ansible

Модуль 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

Имя запланированной задачи, сведения о которой нужно получить.

Если параметр name задан и существует, будут возвращены сведения о самой задаче.

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

Список действий.

Возвращается: указано имя и задача существует

Пример: [{"Arguments": "/c echo hi", "Id": null, "Path": "cmd.exe", "Type": "TASK_ACTION_EXEC", "WorkingDirectory": null}]

folder_exists

boolean

Существует ли папка, указанная в пути.

Возвращается: всегда

Пример: true

folder_task_count

integer

Количество задач в папке.

Возвращается: всегда

Пример: 2

folder_task_names

list / elements=string

Список задач в папке.

Возвращается: всегда

Пример: ["Task 1", "Task 2"]

principal

complex

Сведения о субъекте, настроенном для запуска задачи.

Возвращается: указано имя и задача существует

display_name

string

Имя пользователя/группы, отображаемое в интерфейсе планировщика заданий.

Пример: "Administrator"

group_id

string

Группа, от имени которой будет выполняться задача.

Пример: "BUILTIN\\Administrators"

id

string

Идентификатор субъекта.

Пример: "Author"

logon_type

string

Метод входа в систему, используемый для запуска задачи.

Пример: "TASK_LOGON_INTERACTIVE_TOKEN"

run_level

string

Уровень прав пользователя, используемых для запуска задачи.

Пример: "TASK_RUNLEVEL_LUA"

user_id

string

Пользователь, от имени которого будет выполняться задача.

Пример: "SERVER\\Administrator"

registration_info

complex

Сведения о регистрации задачи.

Возвращается: указано имя и задача существует

author

string

Автор задачи.

Пример: "SERVER\\Administrator"

date

string

Дата регистрации задачи.

Пример: "2017-01-01T10:00:00"

description

string

Описание задачи.

Пример: "task description"

documentation

string

Документация задачи.

Пример: "task documentation"

security_descriptor

string

Дескриптор безопасности задачи.

Пример: "security descriptor"

source

string

Источник задачи.

Пример: "source"

uri

string

URI/путь задачи.

Пример: "\\task\\task name"

version

string

Версия задачи.

Пример: "1.0"

settings

complex

Сведения о параметрах задачи.

Возвращается: указано имя и задача существует

allow_demand_start

boolean

Можно ли запустить задачу с помощью команды «Выполнить» в контекстном меню.

Пример: true

allow_hard_terminate

boolean

Можно ли завершить задачу с помощью TerminateProcess.

Пример: true

compatibility

integer

Уровень совместимости задачи

Пример: 2

delete_expired_task_after

string

Время, которое планировщик заданий будет ожидать перед удалением задачи после истечения срока её действия.

Пример: "PT10M"

disallow_start_if_on_batteries

boolean

Не запускать ли задачу, если компьютер работает от аккумулятора.

Пример: false

disallow_start_on_remote_app_session

boolean

Не запускать ли задачу во время сеанса удалённого приложения.

Пример: true

enabled

boolean

Включена ли задача.

Пример: true

execution_time_limit

string

Время, отведённое на выполнение задачи.

Пример: "PT72H"

hidden

boolean

Скрыта ли задача в интерфейсе.

Пример: false

idle_settings

dictionary

Параметры простоя задачи.

Пример: {"idle_duration": "PT10M", "restart_on_idle": false, "stop_on_idle_end": true, "wait_timeout": "PT1H"}

maintenance_settings

string

Параметры обслуживания задачи.

mulitple_instances

integer

Определяет поведение при запуске уже выполняющейся задачи.

Пример: 2

network_settings

dictionary

Параметры сети задачи.

Пример: {"id": null, "name": null}

priority

integer

Уровень приоритета задачи.

Пример: 7

restart_count

integer

Количество попыток перезапустить задачу в случае сбоя.

Пример: 0

restart_interval

string

Время, в течение которого планировщик заданий будет пытаться перезапустить задачу.

Пример: "PT15M"

run_only_id_idle

boolean

Будет ли задача выполняться, если компьютер находится в состоянии простоя.

Пример: true

run_only_if_network_available

boolean

Будет ли задача выполняться только при наличии сети.

Пример: false

start_when_available

boolean

Можно ли запустить задачу в любое время после наступления запланированного срока её запуска.

Пример: false

stop_if_going_on_batteries

boolean

Будет ли задача остановлена, если компьютер перейдёт на питание от аккумулятора.

Пример: true

use_unified_scheduling_engine

boolean

Будет ли задача использовать унифицированный механизм планирования.

Пример: false

volatile

boolean

Является ли задача временной.

Пример: false

wake_to_run

boolean

Будет ли задача выводить компьютер из спящего режима к моменту запуска.

Пример: false

state

complex

Сведения о состоянии задачи

Возвращается: указано имя и задача существует

last_run_time

string

Время последнего запуска зарегистрированной задачи.

Пример: "2017-09-20T20:50:00"

last_task_result

integer

Результат последнего запуска задачи.

Пример: 267009

next_run_time

string

Время следующего запланированного запуска задачи.

Пример: "2017-09-20T22:50:00"

number_of_missed_runs

integer

Количество пропущенных запланированных запусков задачи.

Пример: 1

status

string

Состояние задачи: выполняется, остановлена и т. д.

Пример: "TASK_STATE_RUNNING"

task_exists

boolean

Существует ли задача в папке.

Возвращается: указано имя

Пример: true

triggers

list / elements=string

Список триггеров.

Возвращается: указано имя и задача существует

Пример: [{"delay": "PT15M", "enabled": true, "end_boundary": null, "execution_time_limit": null, "id": null, "repetition": {"duration": null, "interval": null, "stop_at_duration_end": false}, "start_boundary": null, "type": "TASK_TRIGGER_BOOT"}, {"days_of_month": "5,15,30", "enabled": true, "end_boundary": null, "execution_time_limit": null, "id": null, "months_of_year": "june,december", "random_delay": null, "repetition": {"duration": null, "interval": null, "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–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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API