Spec-Zone.ru › Ansible 2.8

win_scheduled_task – Управление запланированными задачами

Новая в версии 2.0.

  • Обзор
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Статус

Обзор

  • Создает/изменяет или удаляет запланированные задачи Windows.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
actions
список
добавлено в 2.5
Список действий для настройки задачи.
См. подварианты для получения подробностей о том, как создать каждую запись списка.
При создании задачи ДОЛЖНО быть как минимум одно действие, но при удалении задачи это может быть нулевой или пустой список.
Порядок этого списка важен; модуль гарантирует сохранение порядка при изменении задачи.
Этот модуль поддерживает только тип ExecAction, но все равно может удалить устаревшие типы.
arguments
строка
Строка аргументов для передачи исполняемому файлу.
path
строка / обязательно
Путь к исполняемому файлу для ExecAction.
working_directory
строка
Рабочая директория для запуска исполняемого файла.
allow_demand_start
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да
Можно ли запустить задачу с помощью команды «Запуск» или контекстного меню.
allow_hard_terminate
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да
Можно ли завершить задачу с помощью TerminateProcess.
author
строка
добавлено в 2.5
Автор задачи.
compatibility
целое число
добавлено в 2.5
    Варианты:
  • 0
  • 1
  • 2
Целое число, указывающее, с какой версией планировщика задач совместима задача.
0 означает, что задача совместима с командой AT.
1 означает, что задача совместима с Планировщиком задач 1.0.
2 означает, что задача совместима с Планировщиком задач 2.0.
date
строка
добавлено в 2.5
Дата регистрации задачи.
delete_expired_task_after
строка
добавлено в 2.5
Время ожидания Планировщиком задач перед удалением задачи после истечения срока ее действия.
Задача истекает после превышения конечной границы для всех триггеров, связанных с задачей.
Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
description
строка
добавлено в 2.5
Описание задачи.
disallow_start_if_on_batteries
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да
Запретить запуск задачи, если компьютер работает от батареи.
display_name
строка
добавлено в 2.5
Имя пользователя/группы, отображаемое в пользовательском интерфейсе Планировщика задач.
enabled
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да
Задача включена; она может выполняться только когда yes.
execution_time_limit
строка
добавлено в 2.5
Время, отведенное на выполнение задачи.
Если не задано, ограничение по времени бесконечно.
Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
group
строка
добавлено в 2.5
Группа, которая выполнит задачу.
group и username взаимоисключающие и не могут быть заданы одновременно.
logon_type может быть не задано или равно group.
hidden
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да
Скрыть задачу в пользовательском интерфейсе.
logon_type
строка
добавлено в 2.5
    Варианты:
  • none
  • password
  • s4u
  • interactive_token
  • group
  • service_account
  • token_or_password
Способ входа, с которым будет выполняться задача.
password означает, что пароль будет сохранён, и задача имеет доступ к сетевым ресурсам.
s4u означает, что существующий токен будет использован для выполнения задачи, и пароль с задачей не будет сохранён. Это означает отсутствие доступа к сети или зашифрованным файлам.
interactive_token означает, что пользователь должен быть уже залогинен интерактивно и задача будет выполнена в существующей интерактивной сессии.
group означает, что задача будет выполнена как группа.
service_account означает, что задача будет выполнена от имени учетной записи службы, например, System, Local Service или Network Service.
multiple_instances
целое число
добавлено в 2.5
    Варианты:
  • 0
  • 1
  • 2
  • 3
Целое число, указывающее поведение при запуске задачи, которая уже выполняется.
0 запустит новую инстанцию параллельно с существующими экземплярами этой задачи.
1 подождёт завершения других экземпляров этой задачи перед запуском собственной.
2 не запустит новую инстанцию, если другая уже запущена.
3 остановит другие экземпляры задачи и запустит новый.
name
строка / обязательно
Имя запланированной задачи без пути.
password
строка
добавлено в 2.4
Пароль для учетной записи пользователя, от имени которой будет выполняться запланированная задача.
Необходимо, когда задача выполняется без входа пользователя, за исключением встроенных учетных записей службы.
Если установлено, всегда приводит к изменению, если update_password установлено на no, и не требуется никаких других изменений для службы.
path
строка
Значение по умолчанию:
"\\"
Папка задач, в которой будет храниться эта задача.
Создаст папку, если state=present, и папки ещё нет.
Удалить папку, если state=absent, и задач в папке больше нет.
priority
целое число
добавлено в 2.5
Уровень приоритета (0-10) задачи.
По умолчанию при создании новой задачи это 7.
Подробности о уровнях приоритета см. на https://msdn.microsoft.com/en-us/library/windows/desktop/aa383512.aspx.
restart_count
целое число
добавлено в 2.5
Количество попыток перезапуска задачи планировщиком.
restart_interval
строка
добавлено в 2.5
Время, которое Планировщик задач будет пытаться перезапустить задачу.
Если это задано, то restart_count также должно быть задано.
Максимально разрешенное время — 31 день.
Минимально разрешенное время — 1 минута.
Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
run_level
string
added in 2.4
    Choices:
  • limited
  • highest
Уровень прав пользователя, используемый для выполнения задачи.
Если не указано, задача будет создана с ограниченными правами.

aliases: runlevel
run_only_if_idle
boolean
added in 2.5
    Choices:
  • no
  • yes
Выполнять задачу только если компьютер в режиме ожидания.
run_only_if_network_available
boolean
added in 2.5
    Choices:
  • no
  • yes
Выполнять задачу только при наличии подключения к сети.
source
string
added in 2.5
Источник задачи.
start_when_available
boolean
added in 2.5
    Choices:
  • no
  • yes
Разрешить запуск задачи в любое время после истечения запланированного времени.
state
string
    Choices:
  • absent
  • present ←
Когда state=present гарантирует существование задачи.
Когда state=absent гарантирует, что задачи нет.
stop_if_going_on_batteries
boolean
added in 2.5
    Choices:
  • no
  • yes
Остановить задачу при переходе на питание от батареи.
triggers
list
added in 2.5
Список триггеров для конфигурации задачи.
Подробные сведения о построении каждого элемента списка см. в подразделах.
Порядок элементов в этом списке важен, модуль будет поддерживать порядок при изменении задачи.
Существует множество типов триггеров, см. https://msdn.microsoft.com/ru-ru/library/windows/desktop/aa383868.aspx для списка типов триггеров и их параметров.
Параметры подраздела, перечисленные ниже, не являются обязательными для всех типов триггеров, см. описание для получения дополнительных сведений.
days_of_month
string
Дни месяца от 1 до 31 для триггеров.
Если вы хотите установить триггер на последний день любого месяца, используйте run_on_last_day_of_month.
Может быть списком или строкой через запятую, содержащей номера дней.
Требуется при type=monthly.
days_of_week
string
Дни недели для триггера.
Может быть списком или строкой через запятую, содержащей полные имена дней, например, monday вместо mon.
Обязательно при type - weekly, type=session_state_change.
Необязательно при type=monthlydow.
delay
string
Время задержки запуска задачи после срабатывания триггера.
Необязательно при type - boot, event, logon, registration, session_state_change.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
enabled
boolean
    Choices:
  • no
  • yes
Включить или отключить триггер.
Используется во всех типах триггеров.
end_boundary
string
Конечное время деактивации триггера.
В формате ISO 8601 DateTime YYYY-MM-DDThh:mm:ss.
execution_time_limit
string
Максимальное время выполнения задачи.
Необязательно для всех типов триггеров.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
months_of_year
string
Месяцы года для триггера.
Может быть списком или строкой через запятую, содержащей полные имена месяцев, например, march вместо mar.
Необязательно при type - monthlydow, monthly.
random_delay
string
Время задержки, случайно добавленное к начальному времени триггера.
Необязательно при type - daily, monthlydow, monthly, time, weekly.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
repetition
-
Позволяет определить повторяющее действие триггера, определяющее, как часто выполняется задача и как долго повторяется шаблон повторения после запуска задачи.
Принимает следующие ключи: duration, interval, stop_at_duration_end.
duration
string
Определяет длительность повторения шаблона.
Значение в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
По умолчанию не задано, что означает неограниченное повторение.
interval
string
Время между каждым перезапуском задачи.
Значение в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
stop_at_duration_end
boolean
    Choices:
  • no
  • yes
Остановить экземпляр задачи по окончании цикла повторения.
run_on_last_day_of_month
boolean
    Choices:
  • no
  • yes
Значение Boolean, устанавливающее, выполняется ли задача в последний день месяца.
Необязательно при type - monthly.
run_on_last_week_of_month
boolean
    Choices:
  • no
  • yes
Значение Boolean, устанавливающее, выполняется ли задача в последнюю неделю месяца.
Необязательно при type - monthlydow.
start_boundary
string
Начальное время задачи. Даже если триггер соответствует другим критериям начала, задача не запустится до достижения этого времени.
Если необходимо запустить задачу в 9:00 утра определенного дня, необходимо указать дату активации триггера. Можно задать любую дату, даже прошедшую.
Обязательно при type - daily, monthlydow, monthly, time, weekly, (session_state_change).
Необязательно для других типов триггеров.
В формате ISO 8601 DateTime YYYY-MM-DDThh:mm:ss.
subscription
string
Используется и требуется только для type=event.
Строка запроса XML, определяющая событие, которое запускает триггер.
type
string / required
    Choices:
  • boot
  • daily
  • event
  • idle
  • logon
  • monthlydow
  • monthly
  • registration
  • time
  • weekly
  • session_state_change
Тип триггера, это значение управляет требуемыми параметрами ниже.
user_id
string
Имя пользователя, на который будет нацелен триггер.
Необязательно, когда type logon, session_state_change.
Может быть именем пользователя или SID.
Когда type=logon, и вы хотите, чтобы триггер срабатывал при входе пользователя в группу, оставьте это значение null и установите group на группу, которую вы хотите использовать для запуска.
weeks_interval
integer
Интервал недель для запуска, например, 1 означает каждую неделю, а 2 — через неделю.
Необязательно, когда type=weekly.
weeks_of_month
string
Недели месяца для триггера.
Может быть списком или строкой, разделенной запятыми, чисел от 1 до 4, представляющих первую и четвёртую неделю месяца.
Необязательно, когда type=monthlydow.
update_password
boolean
added in 2.5
    Choices:
  • no
  • yes ←
Обновить пароль даже при отсутствии других изменений.
Когда yes всегда приведет к изменению при выполнении модуля.
username
string
Пользователь, от имени которого будет выполняться запланированная задача.
Будет по умолчанию установлен на текущего пользователя при интерактивном токе, если не указано при создании.

aliases: user
version
string
added in 2.5
Номер версии задачи.
wake_to_run
boolean
added in 2.5
    Choices:
  • no
  • yes
Будет ли задача запускать компьютер, когда придёт время запуска задачи.

Примечания

Примечание

  • В Ansible 2.4 и ранее это можно было запускать только на серверах Server 2012/Windows 8 и новее. Начиная с Ansible 2.5 это ограничение снято.
  • Имена параметров и структура действий и триггеров службы следуют стандартной схеме именования и требованиям RegisteredTask, полезно ознакомиться с этим руководством при возникновении проблем https://msdn.microsoft.com/en-us/library/windows/desktop/aa382542.aspx.

См. также

См. также

win_scheduled_task_stat — Получение информации о задачах планировщика Windows
Официальная документация по модулю win_scheduled_task_stat.

Примеры

- name: Create a task to open 2 command prompts as SYSTEM
  win_scheduled_task:
    name: TaskName
    description: open command prompt
    actions:
    - path: cmd.exe
      arguments: /c hostname
    - path: cmd.exe
      arguments: /c whoami
    triggers:
    - type: daily
      start_boundary: '2017-10-09T09:00:00'
    username: SYSTEM
    state: present
    enabled: yes

- name: Create task to run a PS script as NETWORK service on boot
  win_scheduled_task:
    name: TaskName2
    description: Run a PowerShell script
    actions:
    - path: C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe
      arguments: -ExecutionPolicy Unrestricted -NonInteractive -File C:\TestDir\Test.ps1
    triggers:
    - type: boot
    username: NETWORK SERVICE
    run_level: highest
    state: present

- name: Change above task to run under a domain user account, storing the passwords
  win_scheduled_task:
    name: TaskName2
    username: DOMAIN\User
    password: Password
    logon_type: password

- name: Change the above task again, choosing not to store the password
  win_scheduled_task:
    name: TaskName2
    username: DOMAIN\User
    logon_type: s4u

- name: Create task with multiple triggers
  win_scheduled_task:
    name: TriggerTask
    path: \Custom
    actions:
    - path: cmd.exe
    triggers:
    - type: daily
    - type: monthlydow
    username: SYSTEM

- name: Set logon type to password but don't force update the password
  win_scheduled_task:
    name: TriggerTask
    path: \Custom
    actions:
    - path: cmd.exe
    username: Administrator
    password: password
    update_password: no

- name: Disable a task that already exists
  win_scheduled_task:
    name: TaskToDisable
    enabled: no

- name: Create a task that will be repeated every minute for five minutes
  win_scheduled_task:
    name: RepeatedTask
    description: open command prompt
    actions:
    - path: cmd.exe
      arguments: /c hostname
    triggers:
    - type: registration
      repetition:
        interval: PT1M
        duration: PT5M
        stop_at_duration_end: yes

Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Peter Mounce (@petemounce)
  • 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.8/modules/win_scheduled_task_module.html

Spec-Zone.ru

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