win_scheduled_task - Управление запланированными задачами
Новая версия 2.0.
Краткое описание
- Создает/модифицирует или удаляет запланированные задачи Windows.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| actions (добавлен в 2.5) | Список действий для настройки задачи. См. подварианты для подробностей о построении каждой записи списка. При создании задачи ОБОЯЗАТЕЛЬНО должен быть хотя бы один элемент действия, но при удалении задачи это может быть пустой или нулевой список. Порядок этого списка важен, модуль будет сохранять порядок при изменении задачи. Этот модуль поддерживает только тип ExecAction, но может удалить старые типы legacy. | ||
| path обязательно | Путь к исполняемому файлу для ExecAction. | ||
| working_directory | Рабочая директория для запуска исполняемого файла. | ||
| arguments | Строка аргументов для исполняемого файла. | ||
| allow_demand_start (добавлен в 2.5) |
| Разрешить запуск задачи с помощью команды "Запуск" или контекстного меню. | |
| allow_hard_terminate (добавлен в 2.5) |
| Разрешить завершение задачи с помощью TerminateProcess. | |
| arguments | Аргументы для действия запланированной задачи. УСТАРЕВШИЙ с 2.5, используйте вместо этого параметр actions, чтобы указать список действий для запуска.Будет удален в 2.7. псевдонимы: argument | ||
| author (добавлен в 2.5) | Автор задачи. | ||
| compatibility (добавлен в 2.5) |
| Целочисленное значение, указывающее, с какой версией Планировщика задач совместима задача. 0 означает, что задача совместима с командой AT.1 означает, что задача совместима с Планировщиком задач 1.0.2 означает, что задача совместима с Планировщиком задач 2.0. | |
| date (добавлен в 2.5) | Дата регистрации задачи. | ||
| days_of_week | Дни недели для запуска еженедельной задачи. Укажите список или разделенные запятыми дни в полном виде, например, понедельник вместо пн. УСТАРЕВШИЙ с 2.5, используйте список параметров triggers с типом monthlydow или weekly. Будет удален в 2.7. | ||
| delete_expired_task_after (добавлен в 2.5) | Время ожидания Планировщиком задач перед удалением задачи после истечения срока действия. Задача истекает после превышения конечной границы для всех триггеров, связанных с задачей. Формат ISO 8601 для интервала времени 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. | |
| executable | Путь к исполняемому файлу для действия запланированной задачи. УСТАРЕВШИЙ с 2.5, используйте вместо этого параметр actions, чтобы указать список действий для запуска.Будет удален в 2.7. | ||
| execution_time_limit (добавлен в 2.5) | Ограничение времени выполнения задачи. Если не задано, ограничение времени бесконечно. Формат ISO 8601 для интервала времени P[n]Y[n]M[n]DT[n]H[n]M[n]S. | ||
| frequency |
| Частота запуска задачи. УСТАРЕВШИЙ с 2.5, используйте список параметров triggers и укажите тип в зависимости от необходимой частоты.Будет удален в 2.7. | |
| group (добавлен в 2.5) | Группа, которая будет запускать задачу. group и username взаимно исключают друг друга и не могут быть установлены одновременно.logon_type может быть не установлено или равно group. | ||
| hidden (добавлен в 2.5) |
| Скрыть задачу в пользовательском интерфейсе. | |
| logon_type (добавлен в 2.5) |
| Метод входа для запуска задачи. password означает, что пароль будет сохранен, и задача имеет доступ к сетевым ресурсам.s4u означает, что существующий токен будет использован для запуска задачи, и пароль не будет сохранен с задачей. Нет доступа к сети или зашифрованным файлам.interactive_token означает, что пользователь должен быть уже залогинен интерактивно и будет запущен в существующей интерактивной сессии.group означает, что задача будет запущена как группа.service_account означает, что задача будет запущена учетной записью службы, например, Система, Локальная служба или Служба сети. | |
| multiple_instances (добавлен в 2.5) |
| Целое число, указывающее поведение при запуске задачи, которая уже выполняется. 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 для интервала времени P[n]Y[n]M[n]DT[n]H[n]M[n]S. | ||
| run_level (добавлен в 2.4) |
| Уровень прав пользователя, используемых для запуска задачи. Если не указано, задача будет создана с ограниченными правами. псевдонимы: runlevel | |
| run_only_if_idle (добавлен в 2.5) |
| Запустить задачу только если компьютер находится в состоянии простоя. | |
| run_only_if_network_available (добавлен в 2.5) |
| Запустить задачу только когда доступна сеть. | |
| Источник (добавлено в 2.5) | Источник задачи. | ||
| start_when_available (добавлено в 2.5) |
| Указывает, может ли задача начаться в любое время после того, как прошло запланированное время. | |
| Состояние |
| Когда state=present гарантирует существование задачи.Когда state=absent гарантирует отсутствие задачи. | |
| stop_if_going_on_batteries (добавлено в 2.5) |
| Указывает, будет ли задача остановлена, если компьютер начнёт работать от батареи. | |
| store_password (добавлено в 2.4) |
| Указывает, следует ли хранить пароль пользователя, выполняющего задачу. Если no, задача будет иметь доступ только к локальным ресурсам.УСТАРЕЛО с 2.5, используйте logon_type=password для указания, следует ли хранить пароль для задачи.Будет удалено в 2.7. | |
| Время | Время начала выполнения запланированной задачи. УСТАРЕЛО с 2.5, используйте список параметров triggers и используйте параметр start_boundary для указания времени начала.Будет удалено в 2.7. | ||
| триггеры (добавлено в 2.5) | Список триггеров для настройки задачи. См. подпараметры для получения подробной информации о том, как построить каждую запись списка. Порядок этого списка важен, модуль гарантирует сохранение порядка при изменении задачи. Существует несколько типов триггеров, см. https://msdn.microsoft.com/ru-ru/library/windows/desktop/aa383868.aspx для списка типов триггеров и их параметров. Ниже перечисленные подпараметры не требуются для всех типов триггеров, ознакомьтесь с описанием для получения дополнительной информации. | ||
| execution_time_limit | Максимальное время выполнения задачи. Необязательно для всех типов триггеров. Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. | ||
| start_boundary | Время начала задачи, даже если триггер соответствует другим критериям начала, она не начнётся до наступления этого времени. Если вы хотите запустить задачу в 9 утра определённого дня, вам всё ещё нужно указать дату, на которую триггер активирован. Вы можете установить любую дату, даже прошлую. Обязательно, когда type равно daily, monthlydow, monthly, time, weekly, (изменение состояния сессии).Необязательно для остальных типов триггеров. Формат ISO 8601 DateTime YYYY-MM-DDThh:mm:ss. | ||
| enabled |
| Указывает, включен или выключен триггер Используется для всех типов триггеров. | |
| weeks_interval | Интервал недель для запуска, например, 1 означает каждую неделю, а 2 — каждую вторую неделю.Необязательно, когда type=weekly. | ||
| run_on_last_week_of_month |
| Булево значение, устанавливающее, запускается ли задача в последнюю неделю месяца. Необязательно, когда type равно monthlydow. | |
| subscription | Используется только для type=event и требуется.Строка запроса XML, которая идентифицирует событие, запускающее триггер. | ||
| end_boundary | Время завершения отключения триггера. Формат ISO 8601 DateTime YYYY-MM-DDThh:mm:ss. | ||
| days_of_week | Дни недели для триггера. Может быть списком или строкой, разделённой запятыми, полных названий дней, например, понедельник вместо пн. Требуется, когда type равно weekly, type=session_state_change.Необязательно, когда type=monthlydow. | ||
| repetition | Позволяет определить действие повторения триггера, которое определяет, как часто запускается задача и как долго повторяется шаблон повторения после запуска задачи. Принимает следующие ключи: duration, interval, stop_at_duration_end. duration — продолжительность повторения шаблона и записывается в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. interval — интервал времени между каждым перезапуском задачи и записывается в формате ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. stop_at_duration_end — булево значение, указывающее, останавливается ли запущенный экземпляр задачи по окончании шаблона повторения. | ||
| user_id | Имя пользователя, на которого будет нацелен триггер. Необязательно, когда type равно logon, session_state_change.Может быть именем пользователя или SID. Если type=logon, и вы хотите, чтобы триггер срабатывал при входе пользователя в группу, оставьте это значение пустым и установите group в группу, которую вы хотите использовать для триггера. | ||
| weeks_of_month | Недели месяца для триггера. Может быть списком или строкой, разделённой запятыми, чисел от 1 до 4, представляющих первую по четвёртую недели месяца. Необязательно, когда type=monthlydow. | ||
| delay | Время задержки запуска задачи после срабатывания триггера. Необязательно, когда type равно boot, event, logon, registration, session_state_change.Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. | ||
| random_delay | Время задержки, случайным образом добавляемое к времени начала триггера. Необязательно, когда type равно daily, monthlydow, monthly, time, weekly.Формат ISO 8601 Duration P[n]Y[n]M[n]DT[n]H[n]M[n]S. | ||
| run_on_last_day_of_month |
| Булево значение, устанавливающее, запускается ли задача в последний день месяца. Необязательно, когда type равно monthly. | |
| months_of_year | Месяцы года для триггера. Может быть списком или строкой, разделённой запятыми, полных названий месяцев, например, март вместо мар. Необязательно, когда type равно monthlydow, monthly. | ||
| Тип обязательно |
| Тип триггера, это значение контролирует, какие параметры ниже обязательны. | |
| days_of_month | Дни месяца от 1 до 31 для триггеров. Если вы хотите установить триггер на последний день месяца, используйте run_on_last_day_of_month.Может быть списком или строкой, разделённой запятыми, номерами дней. Требуется, когда type=monthly. | ||
| update_password (добавлено в 2.5) |
| Указывает, следует ли обновлять пароль, даже если другие изменения не произошли. Когда yes всегда приведёт к изменению при выполнении модуля. | |
| имя_пользователя | Пользователь, от имени которого будет выполняться запланированная задача. По умолчанию устанавливается текущий пользователь в интерактивном токе, если не указан при создании. псевдонимы: пользователь | ||
| версия (добавлено в 2.5) | Номер версии задачи. | ||
| wake_to_run (добавлено в 2.5) |
| Указывает, будет ли задача запускать компьютер при необходимости. | |
Примечания
Примечание
- В Ansible 2.4 и более ранних версиях это можно было запускать только на Server 2012/Windows 8 или более поздних версиях. С 2.5 это ограничение снято.
- Имена параметров и структура действий и триггеров службы следуют стандарту именования и требованиям
RegisteredTask, будет полезно ознакомиться с этим руководством, если возникают проблемы https://msdn.microsoft.com/ru-ru/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
Состояние
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- Питер Маунс (@petemounce)
- Джордан Боран (@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.5/modules/win_scheduled_task_module.html
