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

Примечание

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

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

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

Для использования в playbook, укажите: lowlydba.sqlserver.agent_job_step.

Новое в lowlydba.sqlserver 0.1.0

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

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

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

Требования

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

dbatools PowerShell модуль

Параметры

Параметр	Комментарии
command string	Команды, которые будут выполнены службой SQLServerAgent через подсистему.
database string	Имя базы данных, в которой будет выполнен шаг Transact-SQL. Значение по умолчанию: `"master"`
job string / required	Имя задания, к которому нужно добавить шаг.
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`
retry_attempts integer	Количество попыток повтора, которые нужно использовать, если этот шаг завершится неудачей. Значение по умолчанию — `0`. Значение по умолчанию: `0`
retry_interval integer	Время в минутах между попытками повтора. Значение по умолчанию: `0`
sql_instance string / required	Экземпляр 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;"

Значения возврата

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

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