lowlydba.sqlserver.agent_job_schedule 模块 – 配置 SQL 代理作业计划

注意

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

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

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

要在剧本中使用它，请指定：lowlydba.sqlserver.agent_job_schedule。

lowlydba.sqlserver 0.1.0 中的新增功能

概要 

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

要求 

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

dbatools PowerShell 模块

参数 

参数	注释
enabled 布尔值	计划是启用还是禁用。选项 `false` `true`
end_date 字符串	作业执行可以停止的日期。如果 force=true，则结束日期将为 `99991231`，通过 dbatools。格式为 `yyyyMMdd`。
end_time 字符串	任何一天结束作业执行的时间。格式 `HHMMSS`（24 小时制）。如果 (force=true)，则开始时间将为 `23:59:59`。
force 布尔值	force 选项将忽略某些选项错误并假设默认值。它还将删除特定作业的相同名称的任何现有计划。选项 `false` `true`
frequency_interval 字符串	作业执行的天数。对于 frequency_type=Daily，允许的值为 - `EveryDay` 或介于 `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)