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

Примечание

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

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

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

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

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

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

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

Настраивает шаг задания агента.

Требования

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

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
command string	Команды, которые служба SQLServerAgent выполняет с помощью подсистемы.
database string	Имя базы данных, в которой выполняется шаг Transact-SQL. По умолчанию: `"master"`
job string / обязательный	Имя задания, в которое добавляется шаг.
on_fail_action string	Действие, выполняемое при сбое шага. Варианты: `"QuitWithSuccess"` `"QuitWithFailure"` ← (по умолчанию) `"GoToNextStep"` `"GoToStep"`
on_fail_step_id integer	Идентификатор шага в этом задании, который будет выполнен при сбое шага, если on_fail_action=GoToStep. По умолчанию: `0`
on_success_action string	Действие, выполняемое при успешном завершении шага. Варианты: `"QuitWithSuccess"` ← (по умолчанию) `"QuitWithFailure"` `"GoToNextStep"` `"GoToStep"`
on_success_step_id integer	Идентификатор шага в этом задании, который будет выполнен при успешном завершении шага, если on_success_action=GoToStep. По умолчанию: `0`
output_file string добавлено в lowlydba.sqlserver 2.7.0	Полный путь к выходному файлу шага задания. Задает расположение, в которое будет записан результат выполнения шага задания.
retry_attempts integer	Количество повторных попыток при сбое шага. Значение по умолчанию — `0`. По умолчанию: `0`
retry_interval integer	Интервал между повторными попытками в минутах. По умолчанию: `0`
sql_instance string / обязательный	Экземпляр SQL Server, который требуется изменить.
sql_password string	Пароль для проверки подлинности SQL.
sql_username string	Имя пользователя для проверки подлинности SQL.
state string	Следует ли объекту находиться в состоянии `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
step_id integer	Порядковый идентификационный номер шага задания. Нумерация начинается с `1` и увеличивается без пропусков. Обязателен, если state=present.
step_name string	Имя шага. Обязательно, если state=present.
subsystem string	Подсистема, используемая службой SQL Server Agent для выполнения команды. Варианты: `"CmdExec"` `"Distribution"` `"LogReader"` `"Merge"` `"PowerShell"` `"QueueReader"` `"Snapshot"` `"Ssis"` `"TransactSql"` ← (по умолчанию)

Атрибуты

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

Примеры

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

- name: Create a job step
  lowlydba.sqlserver.agent_job_step:
    sql_instance: sql-01.myco.io
    job: MyJob
    step_name: Step1
    step_id: 1
    command: "TRUNCATE TABLE dbo.TestData;"

- name: Create a job step with output file
  lowlydba.sqlserver.agent_job_step:
    sql_instance: sql-01.myco.io
    job: MyJob
    step_name: Step2
    step_id: 2
    command: "SELECT * FROM sys.databases;"
    output_file: "C:\\Logs\\MyJob_Step2.log"

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

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

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