f5networks.f5_modules.bigip_timer_policy 模块 – 在 BIG-IP 上管理定时器策略

注意

此模块是 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_timer_policy

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 系统上的定时器策略。

参数

参数

注释

description

字符串

指定标识定时器策略的描述性文本。

name

字符串 / 必填

指定定时器策略的名称。

partition

字符串

设备分区,用于管理资源。

默认: "Common"

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

包含连接详细信息的字典对象。

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 ← (默认)

rules

列表 / 元素=字典

要分配给定时器策略的规则。

destination_ports

列表 / 元素=字符串

要匹配规则的目标端口列表。

通过指定以短划线 (-) 分隔的起始端口和结束端口来指定端口范围。

仅当您选择了 sctptcpudp 协议时,此字段才可用。

idle_timeout

字符串

指定与定时器策略规则匹配的协议和端口对的空闲超时时间(以秒为单位)。

当为 infinite 时,指定与定时器策略规则匹配的协议和端口对没有空闲超时。

在指定规则时,如果未指定此参数,则默认值为 unspecified

默认: "unspecified"

name

字符串 / 必填

规则的名称。

protocol

字符串

指定正在配置定时器策略规则的 IP 协议条目。 这可能是第 4 层协议(例如 tcpudpsctp)。

只有与配置的协议匹配的流才会使用此规则。

当指定 all-other 时,如果没有特定的 IP 协议规则匹配该流,则该流将匹配所有其他 IP 协议规则。

在指定规则时,如果未指定此参数,则默认为 all-other

选项

  • "all-other" ← (默认)

  • "ah"

  • "bna"

  • "esp"

  • "etherip"

  • "gre"

  • "icmp"

  • "ipencap"

  • "ipv6"

  • "ipv6-auth"

  • "ipv6-crypt"

  • "ipv6-icmp"

  • "isp-ip"

  • "mux"

  • "ospf"

  • "sctp"

  • "tcp"

  • "udp"

  • "udplite"

state

字符串

当为 present 时,确保资源存在。

当为 absent 时,确保删除该资源。

选项

  • "present" ← (默认)

  • "absent"

注释

注意

  • 有关使用 Ansible 管理 F5 Networks 设备的更多信息,请参阅 https://ansible.org.cn/integrations/networks/f5

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

  • F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久化到磁盘,请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关如何正确使用该模块来保存运行配置,请参阅该模块的文档。

示例

- name: Create a timer policy
  bigip_timer_policy:
    name: timer1
    description: My timer policy
    rules:
      - name: rule1
        protocol: tcp
        idle_timeout: indefinite
        destination_ports:
          - 443
          - 80
      - name: rule2
        protocol: 200
      - name: rule3
        protocol: sctp
        idle_timeout: 200
        destination_ports:
          - 21
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a timer policy and all its associated rules
  bigip_timer_policy:
    name: timer1
    description: My timer policy
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

description

字符串

计时器策略的新描述。

返回: changed

示例: "True"

作者

  • Tim Rupp (@caphrim007)