awx.awx.schedule_rruleset 查找 – 生成 rruleset 字符串

注意

此查找插件是 awx.awx 集合(版本 24.6.1)的一部分。

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

要安装它,请使用:ansible-galaxy collection install awx.awx。您需要其他要求才能使用此查找插件,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:awx.awx.schedule_rruleset

概要

  • 根据代表 rrule 的条件返回一个字符串

要求

执行此查找的本地控制器节点需要满足以下要求。

  • pytz

  • python-dateutil >= 2.7.0

术语

参数

注释

术语

字符串 / 必需

规则集的开始日期

用于所有频率

格式应为 YYYY-MM-DD [HH:MM:SS]

关键字参数

这描述了查找的关键字参数。这些是以下示例中的值 key1=value1key2=value2 等:lookup('awx.awx.schedule_rruleset', key1=value1, key2=value2, ...)query('awx.awx.schedule_rruleset', key1=value1, key2=value2, ...)

参数

注释

rules

列表 / 元素=字典 / 必需

rruleset 中的规则数组

byhour

字符串

在此计划中运行的小时数

一个逗号分隔的列表,其中可以包含 0-23 的值

byminute

字符串

在此计划中运行的分钟数

一个逗号分隔的列表,其中可以包含 0-59 的值

bymonth

字符串

此计划将运行的月份

一个逗号分隔的列表,其中可以包含 0-12 的值

bymonthday

字符串

此计划将运行的月份中的某天

一个逗号分隔的列表,其中可以包含 0-31 的值

bysetpos

字符串

指定一个出现次数,对应于频率周期内规则的第 n 次出现。

位置的逗号分隔列表(第一个、第二个、第三个、第四个或最后一个)

byweekday

字符串

在此计划中运行的日期

一个逗号分隔的列表,其中可以包含 sunday、monday、tuesday、wednesday、thursday、friday 的值

byweekno

字符串

在此计划中运行的周数

一个逗号分隔的列表,其中可以包含 ISO8601 中描述的值

byyearday

字符串

在此计划中运行的年份日数

一个逗号分隔的列表,其中可以包含 0-366 的值

end_on

字符串

如何结束此计划

如果未定义,则此计划将永远不会结束

如果这是一个正整数,则此计划将在出现此次数后结束

如果这是 YYYY-MM-DD [HH:MM:SS] 格式的日期,则此计划将在该日期之后结束

用于除 none 之外的所有类型

frequency

字符串 / 必需

计划的频率

none - 运行此计划一次

minute - 每 x 分钟运行此计划

hour - 每 x 小时运行此计划

day - 每 x 天运行此计划

week - 每周运行此计划

month - 每月运行此计划

选择

  • "none"

  • "minute"

  • "hour"

  • "day"

  • "week"

  • "month"

include

布尔值

此规则应包含 (RRULE) 还是排除 (EXRULE)

选择

  • false

  • true ←(默认)

interval

整数

以月、周、天、小时或分钟为单位的重复

用于除 none 之外的所有类型

timezone

字符串

此规则使用的时区

用于所有频率

格式应为 US/Eastern

默认为 America/New_York

备注

注意

  • 当关键字参数和位置参数一起使用时,位置参数必须在关键字参数之前列出:lookup('awx.awx.schedule_rruleset', term1, term2, key1=value1, key2=value2)query('awx.awx.schedule_rruleset', term1, term2, key1=value1, key2=value2)

示例

- name: Create a ruleset for everyday except Sundays
  set_fact:
    complex_rule: "{{ query(awx.awx.schedule_rruleset, '2022-04-30 10:30:45', rules=rrules, timezone='UTC' ) }}"
  vars:
    rrules:
      - frequency: 'day'
        interval: 1
      - frequency: 'day'
        interval: 1
        byweekday: 'sunday'
        include: False

返回值

描述

返回值

字符串

rrule 格式的字符串

已返回:成功

作者

  • John Westcott IV (@john-westcott-iv)

提示

每个条目类型的配置条目都具有从低到高的优先级顺序。例如,列表中较低的变量将覆盖较高的变量。