lowlydba.sqlserver.agent_job 模块 – 配置 SQL Agent 作业

注意

此模块是 lowlydba.sqlserver 集合（版本 2.3.4）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install lowlydba.sqlserver。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 Playbook 中使用它，请指定：lowlydba.sqlserver.agent_job。

lowlydba.sqlserver 0.1.0 中的新增功能

概要

  • 配置 SQL Agent 作业，包括它所属的计划和类别。

要求

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

参数

参数

注释

category

字符串

目标 SQL Agent 作业的类别。必须已存在。

description

字符串

SQL Agent 作业的描述。

enabled

布尔值

在 lowlydba.sqlserver 0.4.0 中添加

是否应启用或禁用 SQL Agent 作业。

选项

  • false

  • true ←（默认）

force

布尔值

如果 force=true，则任何作业类别都将在不存在时创建。

选项

  • false ←（默认）

  • true

job

字符串 / 必需

目标 SQL Agent 作业的名称。

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

返回值

常见的返回值记录在 此处，以下是此模块特有的字段

键

描述

数据

字典

New-DbaAgentJob、Set-DbaAgentJob 或 Remove-DbaAgentJob 函数的输出。

返回：成功，但不在 check_mode 中。

作者

  • John McCall (@lowlydba)