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 中的新增功能

概要

  • 配置代理作业的步骤。

要求

执行此模块的主机需要以下要求。

参数

参数

注释

command

字符串

通过子系统由 SQLServerAgent 服务执行的命令。

database

字符串

要执行 Transact-SQL 步骤的数据库名称。

默认值： "master"

job

字符串 / 必需

要向其添加步骤的作业名称。

on_fail_action

字符串

如果步骤失败，则执行的操作。

选项

  • "QuitWithSuccess"

  • "QuitWithFailure" ← (默认)

  • "GoToNextStep"

  • "GoToStep"

on_fail_step_id

整数

如果步骤失败且 *on_fail_action=GoToStep*，则要执行的此作业中步骤的 ID。

默认值： 0

on_success_action

字符串

如果步骤成功，则执行的操作。

选项

  • "QuitWithSuccess" ← (默认)

  • "QuitWithFailure"

  • "GoToNextStep"

  • "GoToStep"

on_success_step_id

整数

如果步骤成功且 *on_success_action=GoToStep*，则要执行的此作业中步骤的 ID。

默认值： 0

retry_attempts

整数

如果此步骤失败，则要使用的重试次数。默认为 0。

默认值： 0

retry_interval

整数

重试尝试之间的时间间隔（分钟）。

默认值： 0

sql_instance

字符串 / 必需

要修改的 SQL Server 实例。

sql_password

字符串

SQL 身份验证的密码。

sql_username

字符串

SQL 身份验证的用户名。

state

字符串

对象应该是 present 还是 absent。

选项

  • "present" ← (默认)

  • "absent"

step_id

整数

作业步骤的序列标识号。步骤标识号从 1 开始，并连续递增，无间隙。

如果 *state=present*，则为必需。

step_name

字符串

步骤的名称。如果 *state=present*，则为必需。

subsystem

字符串

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)