Spec-Zone.ru › Ansible

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

строка

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

Если 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
END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ

Описание

actions

список / элементы=строка

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

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

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

folder_exists

булево

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

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

Пример: true

folder_task_count

целое число

Количество задач, существующих в папке.

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

Пример: 2

folder_task_names

список / элементы=строка

Список задач, существующих в папке.

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

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

principal

сложное

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

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

display_name

строка

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

Пример: "Administrator"

group_id

строка

Группа, которая запустит задачу.

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

id

строка

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

Пример: "Author"

logon_type

строка

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

Пример: "TASK_LOGON_INTERACTIVE_TOKEN"

run_level

строка

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

Пример: "TASK_RUNLEVEL_LUA"

user_id

строка

Пользователь, который запустит задачу.

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

registration_info

сложное

Подробности о регистрации задачи.

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

author

строка

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

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

date

строка

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

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

description

строка

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

Пример: "task description"

documentation

строка

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

Пример: "task documentation"

security_descriptor

строка

Безопасность задачи.

Пример: "security descriptor"

source

строка

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

Пример: "source"

uri

строка

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

Является ли задача временной (volatile)?

Пример: 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–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

Spec-Zone.ru

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