Модуль lowlydba.sqlserver.agent_job — настройка задания агента SQL

Примечание

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

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

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

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

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

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

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

Настройка задания агента SQL, включая расписания и категорию, к которым оно относится.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
category строка	Категория целевого задания агента SQL. Должна уже существовать.
description строка	Описание задания агента SQL.
enabled логическое значение добавлено в lowlydba.sqlserver 0.4.0	Следует ли включить или отключить задание агента SQL. Варианты: `false` `true` ← (по умолчанию)
force логическое значение	Если force=true, все категории заданий будут созданы, если они ещё не существуют. Варианты: `false` ← (по умолчанию) `true`
job строка / обязательный	Имя целевого задания агента SQL.
owner_login строка	Имя входа владельца базы данных. Если база данных создаётся и значение не указано, по умолчанию используется текущий пользователь.
schedule строка	Имя расписания, с которым следует связать задание. Для одного задания поддерживается только одно расписание.
sql_instance строка / обязательный	Экземпляр SQL Server, который нужно изменить.
sql_password строка	Пароль для аутентификации SQL.
sql_username строка	Имя пользователя для аутентификации SQL.
start_step_id целое число	Номер шага, с которого следует начать выполнение задания.
state строка	Должен ли объект находиться в состоянии `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примечания

Примечание

На медленном оборудовании могут возвращаться устаревшие данные компонентов задания (например, предыдущая категория задания или категория по умолчанию). Поэтому рекомендуется настраивать каждый компонент (расписание, шаг, категорию и т. д.) отдельно.

Примеры

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

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

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

Ключ	Описание
data словарь	Вывод функции `New-DbaAgentJob`, `Set-DbaAgentJob` или `Remove-DbaAgentJob`. Возвращается: при успешном выполнении, но не в режиме 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_module.html