Spec-Zone.ru › Ansible 2.9

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
actions
список
добавлен в 2.5
Список действий для настройки задачи.
См. подварианты для подробностей о построении каждого элемента списка.
При создании задачи ОБЯЗАТЕЛЬНО должен быть хотя бы один элемент, но при удалении задачи это может быть null или пустой список.
Порядок в этом списке важен; модуль гарантирует сохранение порядка при изменении задачи.
Этот модуль поддерживает только тип 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
Пароль для учетной записи пользователя, от имени которой будет выполняться запланированная задача.
Требуется при выполнении задачи без входа пользователя, за исключением встроенных учетных записей службы и управляемых группами учетных записей службы (gMSA).
Если установлено, всегда приведет к изменению, если 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.
уровень_выполнения
строка
добавлен в 2.4
    Варианты:
  • ограниченный
  • высший
Уровень прав пользователя, используемых для выполнения задачи.
Если не указано, задача будет создана с ограниченными правами.

псевдонимы: runlevel
выполнять_только_при_простоях
булево
добавлен в 2.5
    Варианты:
  • нет
  • да
Определяет, будет ли задача выполняться только в случае простоя компьютера.
выполнять_только_при_доступности_сети
булево
добавлен в 2.5
    Варианты:
  • нет
  • да
Определяет, будет ли задача выполняться только при наличии доступной сети.
источник
строка
добавлен в 2.5
Источник задачи.
запускать_при_доступности
булево
добавлен в 2.5
    Варианты:
  • нет
  • да
Указывает, может ли задача запуститься в любое время после того, как пройдёт запланированное время.
состояние
строка
    Варианты:
  • отсутствует
  • присутствует ←
Когда state=present будет гарантировать, что задача существует.
Когда state=absent будет гарантировать, что задача не существует.
останавливать_при_переходе_на_аккумулятор
булево
добавлен в 2.5
    Варианты:
  • нет
  • да
Определяет, будет ли задача остановлена, если компьютер начнёт работать от батареи.
триггеры
список
добавлен в 2.5
Список триггеров для настройки задачи.
См. подварианты для получения подробной информации о том, как создать каждый элемент списка.
Порядок в этом списке важен; модуль гарантирует сохранение порядка при изменении задачи.
Существует несколько типов триггеров; см. https://msdn.microsoft.com/en-us/library/windows/desktop/aa383868.aspx для получения списка типов триггеров и их параметров.
Нижеперечисленные параметры подвариантов не требуются для всех типов триггеров; ознакомьтесь с описанием для получения дополнительной информации.
дни_месяца
строка
Дни месяца от 1 до 31 для триггеров.
Если вы хотите установить триггер на последний день месяца, используйте run_on_last_day_of_month.
Может быть списком или строкой через запятую с номерами дней.
Требуется при type=monthly.
дни_недели
строка
Дни недели для триггера.
Может быть списком или строкой через запятую с полными названиями дней, например, понедельник вместо пн.
Требуется, когда type weekly, type=session_state_change.
Необязательно, когда type=monthlydow.
задержка
строка
Время задержки выполнения задачи после срабатывания триггера.
Необязательно, когда type boot, event, logon, registration, session_state_change.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
включено
булево
    Варианты:
  • нет
  • да
Устанавливает триггер в состояние включения или выключения.
Используется во всех типах триггеров.
конечная_граница
строка
Конечное время, когда триггер отключается.
В формате ISO 8601 DateTime YYYY-MM-DDThh:mm:ss.
предел_времени_выполнения
строка
Максимальное время выполнения задачи.
Необязательно для всех типов триггеров.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
месяцы_года
строка
Месяцы года для триггера.
Может быть списком или строкой через запятую с полными названиями месяцев, например, март вместо мар.
Необязательно, когда type monthlydow, monthly.
случайная_задержка
строка
Время задержки, случайно добавляемое к начальному времени триггера.
Необязательно, когда type daily, monthlydow, monthly, time, weekly.
В формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
повторение
-
Позволяет определить повторяющееся действие триггера, определяющее, как часто запускается задача и как долго повторяется этот паттерн после запуска задачи.
Принимает следующие ключи: duration, interval, stop_at_duration_end
продолжительность
строка
Определяет, как долго повторяется паттерн.
Значение в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
По умолчанию не установлено, что означает бесконечное повторение.
интервал
строка
Время между каждым перезапуском задачи.
Значение в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S.
останавливать_по_окончании_продолжительности
булево
    Варианты:
  • нет
  • да
Определяет, будет ли запущенный экземпляр задачи остановлен по завершении повторяющегося паттерна.
выполнять_в_последний_день_месяца
булево
    Варианты:
  • нет
  • да
Булевое значение, устанавливающее, будет ли задача запускаться в последний день месяца.
Необязательно, когда type monthly.
выполнять_в_последнюю_неделю_месяца
булево
    Варианты:
  • нет
  • да
Булевое значение, устанавливающее, будет ли задача запускаться в последнюю неделю месяца.
Необязательно, когда type monthlydow.
начальная_граница
строка
Начальное время запуска задачи. Даже если триггер соответствует другим критериям запуска, задача не запустится до наступления этого времени.
Если вы хотите запустить задачу в 9:00 утра определённого дня, вам всё равно нужно указать дату активации триггера. Вы можете установить любую дату, даже прошлую.
Требуется при type daily, monthlydow, time, weekly, (изменение_состояния_сеанса).
Необязательно для остальных типов триггеров.
В формате ISO 8601 DateTime YYYY-MM-DDThh:mm:ss.
подписка
строка
Используется и требуется только для type=event.
Строка запроса XML, определяющая событие, запускающее триггер.
тип
строка / обязательно
    Варианты:
  • загрузка
  • ежедневно
  • событие
  • простой
  • вход
  • monthlydow
  • ежемесячно
  • регистрация
  • время
  • еженедельно
  • изменение_состояния_сеанса
Тип триггера; это значение определяет, какие нижеследующие параметры являются обязательными.
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 и ранее это можно было запускать только на сервере 2012/Windows 8 или более поздней версии. С Ansible 2.5 это ограничение снято.
  • Имена опций и структура действий и триггеров службы следуют стандарту именования и требованиям RegisteredTask, было бы полезно ознакомиться с этим руководством, если возникают какие-либо проблемы https://msdn.microsoft.com/en-us/library/windows/desktop/aa382542.aspx.
  • Учетную запись службы с управляемой группой (gMSA) можно использовать, установив logon_type на password и опуская параметр пароля. Более подробную информацию о gMSA см. в https://techcommunity.microsoft.com/t5/Core-Infrastructure-and-Security/Windows-Server-2012-Group-Managed-Service-Accounts/ba-p/255910

См. также

См. также

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: Change above task to use a gMSA, where the password is managed automatically
  win_scheduled_task:
    name: TaskName2
    username: DOMAIN\gMsaSvcAcct$
    logon_type: password

- 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

Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.9/modules/win_scheduled_task_module.html

Spec-Zone.ru

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