f5networks.f5_modules.bigip_firewall_schedule 模块 – 管理 BIG-IP AFM 日程配置

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定： f5networks.f5_modules.bigip_firewall_schedule。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP AFM（高级防火墙管理器）日程配置。

参数

参数	注释
daily_hour_end 字符串	指定规则停止使用的每日时间。 未定义时，创建新日程时使用默认值 24:00。 时区始终假定为 UTC，值必须使用 24 小时制格式提供为 HH:MM。
daily_hour_start 字符串	指定规则开始使用的每日时间。 该值必须早于 daily_hour_end。 未定义时，创建新日程时使用默认值 0:00。 当值设置为 all-day 时，daily_hour_end 和 daily_hour_start 将分别重置为其各自的默认值。 时区始终假定为 UTC，值必须使用 24 小时制格式提供为 HH:MM。
date_valid_end 字符串	指定此日程将应用于规则的结束日期/时间。 日期必须晚于 date_valid_start 未定义时，创建新日程时使用默认值 indefinite。 时区始终假定为 UTC。 日期时间格式应始终为 YYYY-MM-DD:HH:MM:SS 格式。
date_valid_start 字符串	指定此日程将应用于规则的开始日期/时间。 未定义时，创建新日程时使用默认值 epoch。 时区始终假定为 UTC。 日期时间格式应始终为 YYYY-MM-DD:HH:MM:SS 格式。
days_of_week 列表 / 元素=字符串	指定规则将应用于一周中的哪些日子。 未定义时，创建新日程时使用默认值 all。 all 值与其他选择互斥。 选项 "星期日" "星期一" "星期二" "星期三" "星期四" "星期五" "星期六" "全部"
description 字符串	指定用户定义的描述文本。
name 字符串 / 必需	指定 AFM 日程配置的名称。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth provider 以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass，pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
transport 字符串	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理员权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
state 字符串	当 present 时，确保资源存在。 当 absent 时，确保资源被删除。 选项 "present" ← (默认) "absent"

注释

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 特定配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块文档以了解保存运行配置的正确使用方法。

示例

- name: Create a 6 hour two day schedule, no start/end date
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: 13:00
    daily_hour_end: 19:00
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a seven day schedule with start/end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "{{ lookup('pipe','date -d \"now + 7 days\" +%Y-%m-%d:%H:%M:%S') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify created schedule to all-day
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: all-day
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a schedule to have no end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "indefinite"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove created schedule
  bigip_firewall_schedule:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
daily_hour_end 字符串	规则停止使用的每日时间。 返回值：changed 示例： "18:00"
daily_hour_start 字符串	规则开始使用的每日时间。 返回值：changed 示例： "13:00"
date_valid_end 字符串	时间计划将应用于规则的结束日期/时间。 返回值：changed 示例： "2019-03-11:15:30:00"
date_valid_start 字符串	时间计划将应用于规则的开始日期/时间。 返回值：changed 示例： "2019-03-01:15:30:00"
days_of_week 列表 / 元素=字符串	将应用规则的星期几。 返回值：changed 示例： ["monday", "tuesday"]
description 字符串	用户定义的描述文本。 返回值：changed 示例： "Foo is bar"

作者

• Wojciech Wypior (@wojtek0806)

收藏链接

• 问题追踪器
• 主页
• 代码库 (源代码)