lowlydba.sqlserver.agent_job_schedule 模块 – 配置 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_schedule。

lowlydba.sqlserver 0.1.0 中的新增功能

概要

• 配置可应用于一个或多个代理作业的代理计划的设置。

要求

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

• dbatools PowerShell 模块

参数

参数	注释
enabled 布尔值	计划是启用还是禁用。 选项 false true
end_date 字符串	作业可以停止执行的日期。 如果 force=true，则结束日期将通过 dbatools 设置为 99991231。 格式为 yyyyMMdd。
end_time 字符串	在任何一天结束作业执行的时间。格式为 HHMMSS （24 小时制）。 如果 (force=true)，则开始时间将为 23:59:59。
force 布尔值	force 选项将忽略选项中的一些错误并采用默认值。 它还会删除特定作业的任何同名计划。 选项 false true
frequency_interval 字符串	执行作业的天数。 frequency_type=Daily 允许的值 - EveryDay 或介于 1 和 365 之间的数字（包括 1 和 365）。 frequency_type=Weekly 允许的值 - Sunday、Monday、Tuesday、Wednesday、Thursday、Friday、Saturday、Weekdays、Weekend 或 EveryDay。 frequency_type=Monthly 允许的值 - 每个月的第 1 到 31 天的数字。 如果使用 Weekdays、Weekend 或 EveryDay，则它会覆盖之前传递的任何其他值。 如果 force=true，则默认值将为 1。
frequency_recurrence_factor 整数	计划执行作业的间隔周数或月数。 如果 frequency_type=Weekly、frequency_type=Monthly 或 frequency_type=MonthlyRelative，则为必需参数。
frequency_relative_interval 字符串	作业在每个月中的 frequency_interval 发生次数。如果 frequency_interval=32（MonthlyRelative）。 选项 “未使用” “第一” “第二” “第三” “第四” “最后”
frequency_subday_interval 整数	在每次执行作业之间发生的子日类型周期数。
frequency_subday_type 字符串	指定子日 frequency_interval 的单位。 选项 “时间” “秒” “分钟” “小时”
frequency_type 字符串	指示何时执行作业的值。 如果 force=true，则默认值将为 Once。 选项 “一次” “单次” “每日” “每周” “每月” “相对每月” “代理启动” “自动启动” “空闲计算机” “空闲时”
job 字符串 / 必需	具有计划的作业的名称。 计划和作业也可以通过 lowlydba.sqlserver.agent_job 关联。 有关更详细的用法，请参阅 https://docs.dbatools.io/New-DbaAgentSchedule。
schedule 字符串 / 必需	计划的名称。
sql_instance 字符串 / 必需	要修改的 SQL Server 实例。
sql_password 字符串	SQL 身份验证的密码。
sql_username 字符串	SQL 身份验证的用户名。
start_date 字符串	作业可以开始执行的日期。 如果 force=true，则开始日期将为当前日期。 格式为 yyyyMMdd。
start_time 字符串	在任何一天开始执行作业的时间。格式为 HHMMSS (24 小时制)。 如果 force=true，则开始时间将为 00:00:00。
state 字符串	对象应该是 present 还是 absent。 选项 "present" ← (默认) "absent"

属性

属性	支持	描述
check_mode	支持: 完全	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。
platform	平台: 全部	可以操作的目标操作系统/系列。

示例

- name: Create a job schedule
  lowlydba.sqlserver.agent_job_schedule:
    sql_instance: sql-01.myco.io
    schedule: DailySchedule
    force: true
    enabled: true
    start_date: 2020-05-25  # May 25, 2020
    end_date: 2099-05-25    # May 25, 2099
    start_time: 010500      # 01:05:00 AM
    end_time: 140030        # 02:00:30 PM
    state: present

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

返回值

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

键	描述
data 字典	来自 New-DbaAgentJobSchedule 或 Remove-DbaAgentJobSchedule 函数的输出。 返回: 成功，但不在 check_mode 中。

作者

• John McCall (@lowlydba)

集合链接

• 问题跟踪器
• 存储库（来源）