Модуль lowlydba.sqlserver.agent_job_schedule — настройка расписания задания SQL Agent

Примечание

Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.8.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install lowlydba.sqlserver. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: lowlydba.sqlserver.agent_job_schedule.

Добавлено в lowlydba.sqlserver 0.1.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Настраивает параметры расписания агента, которое можно применить к одному или нескольким заданиям агента.

Требования

Следующие требования необходимы на хосте, на котором выполняется этот модуль.

dbatools — модуль PowerShell

Параметры

Параметр	Комментарии
enabled boolean	Включено или отключено расписание. Варианты: `false` `true`
end_date string	Дата, после которой выполнение задания может прекратиться. Если force=true, конечная дата будет `99991231` с помощью dbatools. Формат: `yyyyMMdd`.
end_time string	Время окончания выполнения задания в любой день. Формат `HHMMSS` (24-часовой формат). Если (force=true), время начала будет `23:59:59`.
force boolean	Параметр force игнорирует некоторые ошибки в параметрах и использует значения по умолчанию. Он также удаляет все существующие расписания с тем же именем для указанного задания. Варианты: `false` `true`
frequency_interval string	Дни, в которые выполняется задание. Допустимые значения для frequency_type=Daily — `EveryDay` или число от `1` до `365` включительно. Допустимые значения для frequency_type=Weekly — `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Weekdays`, `Weekend` или `EveryDay`. Допустимые значения для frequency_type=Monthly — числа от `1` до `31` для каждого дня месяца. Если используется `Weekdays`, `Weekend` или `EveryDay`, это переопределяет все ранее переданные значения. Если force=true, по умолчанию используется `1`.
frequency_recurrence_factor integer	Количество недель или месяцев между запланированными запусками задания. Обязательно, если frequency_type=Weekly, frequency_type=Monthly или frequency_type=MonthlyRelative.
frequency_relative_interval string	Порядковый номер вхождения frequency_interval в каждом месяце. Если frequency_interval=32 (`MonthlyRelative`). Варианты: `"Unused"` `"First"` `"Second"` `"Third"` `"Fourth"` `"Last"`
frequency_subday_interval integer	Количество периодов подневной частоты между запусками задания.
frequency_subday_type string	Задает единицы измерения для подневного параметра frequency_interval. Варианты: `"Time"` `"Seconds"` `"Minutes"` `"Hours"`
frequency_type string	Значение, определяющее, когда должно выполняться задание. Если force=true, по умолчанию используется `Once`. Варианты: `"Once"` `"OneTime"` `"Daily"` `"Weekly"` `"Monthly"` `"MonthlyRelative"` `"AgentStart"` `"AutoStart"` `"IdleComputer"` `"OnIdle"`
job string / обязательный	Имя задания, для которого задано расписание. Расписания и задания также можно связать с помощью lowlydba.sqlserver.agent_job. Подробные сведения об использовании см. на странице https://docs.dbatools.io/New-DbaAgentSchedule.
schedule string / обязательный	Имя расписания.
sql_instance string / обязательный	Экземпляр SQL Server, который нужно изменить.
sql_password string	Пароль для аутентификации SQL.
sql_username string	Имя пользователя для аутентификации SQL.
start_date string	Дата, начиная с которой может выполняться задание. Если force=true, датой начала будет текущий день. Формат: `yyyyMMdd`.
start_time string	Время начала выполнения задания в любой день. Формат `HHMMSS` (24-часовой формат). Если force=true, время начала будет `00:00:00`.
state string	Должен ли объект быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.
platform	Платформы: все	Целевые ОС и их семейства, с которыми можно работать.

Примеры

- name: Create a job schedule
  lowlydba.sqlserver.agent_job_schedule:
    sql_instance: sql-01.myco.io
    schedule: DailySchedule
    force: true
    enabled: true
    start_date: 2020-05-25  # May 25, 2020
    end_date: 2099-05-25    # May 25, 2099
    start_time: 010500      # 01:05:00 AM
    end_time: 140030        # 02:00:30 PM
    state: present

- name: Create a job with schedule
  lowlydba.sqlserver.agent_job:
    sql_instance: sql-01.myco.io
    job: MyJob
    force: true
    schedule: DailySchedule

Возвращаемые значения

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

Ключ	Описание
data dictionary	Результат функции `New-DbaAgentJobSchedule` или `Remove-DbaAgentJobSchedule`. Возвращается: при успешном выполнении, но не в режиме check_mode.

Авторы

John McCall (@lowlydba)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/lowlydba/sqlserver/agent_job_schedule_module.html