f5networks.f5_modules.bigip_profile_udp 模块 – 在 BIG-IP 上管理 UDP 配置文件

注意

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

f5networks.f5_modules 1.0.0 中的新功能

概要

  • 在 BIG-IP 系统上管理 UDP 配置文件。有许多 UDP 配置文件,每个配置文件都对标准的 udp 配置文件进行了调整。此模块的用户应该知道,许多可用选项没有模块默认值。相反,默认值由 BIG-IP 系统本身分配,在大多数情况下,这是可以接受的。

参数

参数

注释

datagram_load_balancing

布尔值

true 时,指定系统逐包负载均衡 UDP 流量。

选项

  • false

  • true

idle_timeout

字符串

指定连接空闲(没有流量)多长时间后,该连接才有资格被删除。

创建新配置文件时,如果未指定此参数,则远程设备将根据其 配置文件选择适合该配置文件的默认值。

当指定一个数字时,表示 UDP 连接在系统删除它之前可以保持空闲的秒数。

indefinite 时,指定 UDP 连接可以无限期地保持空闲。

0immediate 时,指定您不希望 UDP 连接保持空闲,因此它立即有资格被删除。

name

字符串 / 必需

指定配置文件的名称。

parent

字符串

指定此配置文件从中继承设置的配置文件。

创建新配置文件时,如果未指定此参数,则默认值为系统提供的 udp 配置文件。

partition

字符串

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

默认值: "Common"

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

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

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 Networks 设备的更多信息,请参阅 https://ansible.org.cn/integrations/networks/f5

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

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

示例

- name: Create a TCP profile
  bigip_profile_tcp:
    name: foo
    parent: udp
    idle_timeout: 300
    datagram_load_balancing: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

常见的返回值在这里有文档记录,以下是此模块独有的字段

描述

datagram_load_balancing

布尔值

资源的新的数据报负载均衡设置。

返回: changed

示例: true

idle_timeout

整数

资源的新的空闲超时时间。

返回: changed

示例: 100

parent

字符串

资源的新的父级。

返回: changed

示例: "udp"

作者

  • Tim Rupp (@caphrim007)