win_scheduled_task – Управление запланированными задачами
Новая версия 2.0.
Описание
- Создает/модифицирует или удаляет запланированные задачи Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| действия список добавлено в 2.5 | Список действий для настройки задачи. См. подварианты для получения подробностей о построении каждого элемента списка. При создании задачи ДОЛЖНО быть как минимум одно действие, но при удалении задачи это может быть пустой или нулевой список. Порядок этого списка важен, модуль гарантирует, что порядок будет сохранен при изменении задачи. Этот модуль поддерживает только тип ExecAction, но всё ещё может удалять более старые типы. | |||
| аргументы - | Строка аргументов для выполнения исполняемого файла. | |||
| путь - / обязательно | Путь к исполняемому файлу для ExecAction. | |||
| рабочая_директория - | Рабочая директория для запуска исполняемого файла. | |||
| разрешить_запуск_по_требованию булево добавлено в 2.5 |
| Можно ли запустить задачу с помощью команды «Запуск» или контекстного меню. | ||
| разрешить_жесткое_прерывание булево добавлено в 2.5 |
| Можно ли прервать задачу с помощью TerminateProcess. | ||
| автор - добавлено в 2.5 | Автор задачи. | |||
| совместимость целое добавлено в 2.5 |
| Целое значение, указывающее, с какой версией Планировщика задач совместима задача. 0 означает, что задача совместима с командой AT.1 означает, что задача совместима с Планировщиком задач 1.0.2 означает, что задача совместима с Планировщиком задач 2.0. | ||
| дата - добавлено в 2.5 | Дата регистрации задачи. | |||
| удалить_просроченную_задачу_через - добавлено в 2.5 | Время, которое Планировщик задач будет ждать перед удалением задачи после её истечения. Задача истекает после того, как для всех триггеров, связанных с задачей, будет превышен предел окончания. Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| описание - добавлено в 2.5 | Описание задачи. | |||
| запретить_запуск_от_аккумулятора булево добавлено в 2.5 |
| Не запускать задачу, если компьютер питается от батареи. | ||
| отображаемое_название - добавлено в 2.5 | Имя пользователя/группы, отображаемое в пользовательском интерфейсе Планировщика задач. | |||
| включено булево добавлено в 2.5 |
| Задача включена, задача может выполняться только, когда yes. | ||
| лимит_времени_выполнения - добавлено в 2.5 | Предел времени для выполнения задачи. Если не задано, предел времени — бесконечен. Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| группа - добавлено в 2.5 | Группа, которая выполнит задачу. group и username взаимоисключающие и не могут быть установлены одновременно.logon_type может быть не задано или равно group. | |||
| скрыто булево добавлено в 2.5 |
| Задача будет скрыта в пользовательском интерфейсе. | ||
| тип_входа - добавлено в 2.5 |
| Метод входа, с которым будет работать задача. password означает, что пароль будет сохранён, и задача имеет доступ к сетевым ресурсам.s4u означает, что будет использован существующий токен для выполнения задачи и пароль не будет сохранён с задачей. Не дает доступа к сети или зашифрованным файлам.interactive_token означает, что пользователь должен быть уже интерактивно подключён и будет работать в существующей интерактивной сессии.group означает, что задача будет выполняться как группа.service_account означает, что задача будет выполняться учетной записью сервиса, такой как System, Local Service или Network Service. | ||
| несколько_экземпляров целое добавлено в 2.5 |
| Целое число, которое указывает поведение при запуске задачи, которая уже выполняется. 0 запустит новый экземпляр параллельно с существующими экземплярами этой задачи.1 будет ждать, пока другие экземпляры этой задачи не завершат работу, прежде чем запустить себя.2 не будет запускать новый экземпляр, если другой уже запущен.3 остановит другие экземпляры задачи и запустит новый. | ||
| имя - / обязательно | Имя запланированной задачи без пути. | |||
| пароль - добавлено в 2.4 | Пароль для учетной записи пользователя, от имени которой будет выполняться запланированная задача. Это требуется при выполнении задачи без входа пользователя, за исключением встроенных учетных записей сервисов. Если установлено, всегда приведет к изменению, если update_password установлено в no и другие изменения для сервиса не требуются. | |||
| путь - | По умолчанию: "\\" | Папка задач, в которой будет храниться эта задача. Будет создана папка, когда state=present и папка еще не существует.Будет удалена папка, когда state=absent и в папке не осталось задач. | ||
| приоритет целое добавлено в 2.5 | Уровень приоритета задачи (0-10). При создании новой задачи значение по умолчанию — 7. См. https://msdn.microsoft.com/en-us/library/windows/desktop/aa383512.aspx для получения подробностей об уровнях приоритета. | |||
| количество_повторов целое добавлено в 2.5 | Количество попыток перезапуска задачи Планировщиком задач. | |||
| интервал_перезапуска - добавлено в 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 для продолжительности P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| включено логическое_значение |
| Устанавливает триггер в состояние включено или выключено. Используется для всех типов триггеров. | ||
| граница_окончания - | Время окончания действия триггера. Формат ISO 8601 для даты и времени YYYY-MM-DDThh:mm:ss. | |||
| предел_времени_выполнения - | Максимальное время выполнения задачи. Необязательно для всех типов триггеров. Формат ISO 8601 для продолжительности P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| месяцы_года - | Месяцы года для триггера. Может быть списком или строкой полных названий месяцев, разделённых запятыми (например, март вместо мар). Необязательно при type равно monthlydow, monthly. | |||
| случайная_задержка - | Время задержки, которое случайно добавляется к начальному времени триггера. Необязательно при type равно daily, monthlydow, monthly, time, weekly. Формат ISO 8601 для продолжительности P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| повторение - | Позволяет определить действие повторения триггера, определяющее, как часто выполняется задача и как долго повторяется шаблон повторения после запуска задачи. Принимает следующие ключи: duration, interval, stop_at_duration_end | |||
| продолжительность строка | Определяет, как долго повторяется шаблон. Значение в формате ISO 8601 для продолжительности P[n]Y[n]M[n]DT[n]H[n]M[n]S. По умолчанию не задано, что означает бесконечное повторение. | |||
| интервал строка | Время между каждым перезапуском задачи. Значение в формате ISO 8601 для продолжительности P[n]Y[n]M[n]DT[n]H[n]M[n]S. | |||
| остановить_по_окончании_продолжительности логическое_значение |
| Определяет, останавливается ли запущенный экземпляр задачи по окончании шаблона повторения. | ||
| выполнять_в_последний_день_месяца логическое_значение |
| Логическое значение, определяющее, выполняется ли задача в последний день месяца. Необязательно при type равно monthly. | ||
| выполнять_в_последнюю_неделю_месяца логическое_значение |
| Логическое значение, определяющее, выполняется ли задача в последнюю неделю месяца. Необязательно при type равно monthlydow. | ||
| начальная_граница - | Начальное время задачи. Даже если триггер соответствует другим критериям запуска, задача не запустится, пока не будет достигнуто это время. Если вы хотите запустить задачу в 9 утра какого-то дня, вам всё равно необходимо указать дату активации триггера. Вы можете установить любую дату, даже прошлую. Обязательно при type равно daily, monthlydow, monthly, time, weekly, (изменение_состояния_сеанса).Необязательно для остальных типов триггеров. Формат ISO 8601 для даты и времени YYYY-MM-DDThh:mm:ss. | |||
| подписка - | Используется только для type=event.XML-строка запроса, которая идентифицирует событие, запускающее триггер. | |||
| тип - / обязательно |
| Тип триггера. Это значение определяет, какие из ниже перечисленных параметров обязательны. | ||
| user_id - | Имя пользователя, на которого будет нацелен триггер. Необязательно, когда type logon, session_state_change.Может быть именем пользователя или SID. Если type=logon и вы хотите, чтобы триггер срабатывал при входе пользователя в группу, оставьте это значение пустым и установите group в группу, которую вы хотите использовать для триггера. | |||
| weeks_interval - | Интервал недель для запуска, например 1 означает каждую неделю, а 2 означает каждую вторую неделю.Необязательно, когда type=weekly. | |||
| weeks_of_month - | Недели месяца для триггера. Может быть списком или строкой, разделенной запятыми, чисел от 1 до 4, представляющих первую по четвёртую неделю месяца. Необязательно, когда type=monthlydow. | |||
| update_password boolean added in 2.5 |
| Обновить пароль, даже если не произошло других изменений. Если yes всегда приведёт к изменению при выполнении модуля. | ||
| username - | Пользователь, от имени которого будет выполняться запланированная задача. По умолчанию используется текущий пользователь в интерактивном токе, если не указано при создании. aliases: user | |||
| version - added in 2.5 | Номер версии задачи. | |||
| wake_to_run boolean added in 2.5 |
| Разрешить задаче пробудить компьютер, когда придёт время запуска задачи. | ||
Примечания
Примечание
- В Ansible 2.4 и более ранних версиях, это можно было запускать только на Server 2012/Windows 8 или новее. С версии 2.5 это ограничение снято.
- Имена опций и структура действий и триггеров службы следуют стандартной схеме именования и требованиям
RegisteredTask, полезно ознакомиться с этим руководством, если возникают проблемы https://msdn.microsoft.com/en-us/library/windows/desktop/aa382542.aspx.
Примеры
- 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
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/win_scheduled_task_module.html