Модуль lowlydba.sqlserver.agent_job_schedule – Настройка расписания задания агента SQL

Примечание

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

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

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

Для использования в плейбуке укажите: lowlydba.sqlserver.agent_job_schedule.

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

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
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	Количество периодов типа subday, которые должны произойти между каждым выполнением задания.
frequency_subday_type string	Указывает единицы для интервала frequency_interval subday. Варианты: `"Time"` `"Seconds"` `"Minutes"` `"Hours"`
frequency_type string	Значение, указывающее, когда должно выполняться задание. Если force=true, значение по умолчанию будет `Once`. Варианты: `"Once"` `"OneTime"` `"Daily"` `"Weekly"` `"Monthly"` `"MonthlyRelative"` `"AgentStart"` `"AutoStart"` `"IdleComputer"` `"OnIdle"`
job string / required	Имя задания, имеющего расписание. Расписания и задания также могут быть связаны через lowlydba.sqlserver.agent_job. См. https://docs.dbatools.io/New-DbaAgentSchedule для более подробного использования.
schedule string / required	Имя расписания.
sql_instance string / required	Экземпляр 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 словарь	Вывод из функции `New-DbaAgentJobSchedule` или `Remove-DbaAgentJobSchedule`. Возвращается: при успешном выполнении, но не в режиме check_mode.

Авторы

John McCall (@lowlydba)

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

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