f5networks.f5_modules.bigip_log_destination 模块 – 管理 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_log_destination。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 设备上的日志目标。

参数

参数	注释
address 字符串	指定将接收来自指定本地日志目标的消息的 IP 地址。 此参数仅在 type 为 management-port 时可用。 创建新的日志目标且 type 为 management-port 时，此参数是必需的。
description 字符串	日志目标的描述。
distribution 字符串	指定远程高速日志目标用于将消息发送到池成员的分布方法。 当为 adaptive 时，将根据需要添加与池成员的连接以提供足够的日志记录带宽。这可能会有不良影响，即当单个池成员提供足够的日志记录带宽时，日志只会在该成员上累积。 当为 balanced 时，将每个后续日志发送到新的池成员，根据池的负载均衡方法在池成员之间平衡日志。 当为 replicated 时，将每个日志复制到所有池成员，以实现冗余。 创建新的日志目标且 type 为 remote-high-speed-log 时，如果未指定此参数，则默认为 adaptive。 选项 "adaptive" "balanced" "replicated"
forward_to 字符串	当 type 为 remote-syslog 时，指定管理端口日志目标，该目标将用于将日志转发到单个日志服务器，或远程高速日志目标，该目标将用于将日志转发到远程日志服务器池。 当 type 为 splunk 或 arcsight 时，指定将日志转发到的日志目标。此日志目标可以是管理端口目标、远程高速日志目标或配置为将日志发送到 ArcSight 或 Splunk 服务器的远程 Syslog 目标。 创建新的日志目标且 type 为 remote-syslog、splunk 或 arcsight 时，此参数是必需的。
name 字符串 / 必需	指定日志目标的名称。
partition 字符串	要在其上管理资源的设备分区。 默认值： "Common"
pool 字符串	当 type 为 remote-high-speed-log 时，指定将发送日志的现有远程高速日志服务器池。 当 type 为 ipfix 时，指定现有远程 IPFIX 收集器的 LTM 池。使用此日志目标的任何 BIG-IP 应用程序都会将其 IP 流量日志发送到此收集器池。 创建新的目标且 type 为 remote-high-speed-log 或 ipfix 时，此参数是必需的。
port 整数	指定将接收来自指定本地日志目标的消息的 IP 地址的端口。 此参数仅在 type 为 management-port 时可用。 创建新的日志目标且 type 为 management-port 时，此参数是必需的。
protocol 字符串	当 type 为 remote-high-speed-log 时，指定系统用于将日志发送到存储日志的远程高速日志服务器池的协议。 当 type 为 ipfix 时，可以是 IPFIX 或 Netflow v9，具体取决于您在指定的池中拥有的收集器类型。 当 type 为 management-port 时，指定用于将消息发送到指定位置的协议。 当 type 为 management-port 时，只有 tcp 和 udp 是有效值。 选项 "tcp" "udp" "ipfix" "netflow-9"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果为yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量F5_TELEMETRY_OFF来省略此选项。 先前使用的变量F5_TEEM已弃用，因为其名称容易混淆。 选项 false ← (默认) true
密码 别名：pass，pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量F5_PASSWORD来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量F5_SERVER来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 您可以通过设置环境变量F5_SERVER_PORT来省略此选项。 默认值：443
超时 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将报错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理员权限。 您可以通过设置环境变量F5_USER来省略此选项。
验证证书 布尔值	如果为no，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量F5_VALIDATE_CERTS来省略此选项。 选项 false true ← (默认)
服务器 SSL 配置文件 字符串	如果transport_profile是 TCP 配置文件，则可以使用此字段选择一个安全套接字层 (SSL) 配置文件，用于将日志发送到 IPFIX 收集器。 SSL 服务器配置文件定义了如何通过 SSL 或传输层安全性 (TLS) 安全地进行通信。 只有当type为ipfix时，此参数才可用。
状态 字符串	当present时，确保资源存在。 当absent时，确保资源被删除。 选项 "present" ← (默认) "absent"
syslog 格式 字符串	指定用于格式化与远程 Syslog 日志目标关联的日志的方法。 创建新的日志目标（并且type为remote-syslog）时，如果未指定此参数，则默认为bsd-syslog。 syslog和rfc5424选项相同。 bsd-syslog和rfc3164选项相同。 选项 "bsd-syslog" "syslog" "legacy-bigip" "rfc5424" "rfc3164"
模板删除延迟 整数	输入 BIG-IP 设备在删除过时的 IPFIX 模板和重用其模板 ID 之间应暂停的时间（以秒为单位）。 此功能适用于使用 iRules 创建自定义 IPFIX 模板的系统。
模板重传间隔 整数	输入 IPFIX 模板到 IPFIX 收集器池的每次传输之间的时间（以秒为单位）。 日志目标会定期以您在此字段中设置的间隔重传其所有 IPFIX 模板。这些重传对于 UDP（一种易损的传输机制）很有帮助。 只有当type为ipfix时，此参数才可用。
传输配置文件 字符串	基于 TCP 或 UDP 的传输配置文件。 此配置文件定义用于将 IP 流量日志发送到收集器池的 TCP 或 UDP 选项。 只有当type为ipfix时，此参数才可用。
类型 字符串 / 必需	指定日志目标的类型。 创建后，此参数无法更改。 选项 "remote-high-speed-log" "remote-syslog" "arcsight" "splunk" "management-port" "ipfix"

注释

注意

• 有关使用 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 high-speed logging destination
  bigip_log_destination:
    name: foo
    type: remote-high-speed-log
    pool: my-ltm-pool
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a remote-syslog logging destination
  bigip_log_destination:
    name: foo
    type: remote-syslog
    syslog_format: rfc5424
    forward_to: my-destination
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

公共返回值已在此处记录此处，以下是此模块特有的字段

键	描述
address 字符串	新的地址值。 返回：已更改 示例："1.2.3.2"
distribution 字符串	新的分发方法值。 返回：已更改 示例："balanced"
forward_to 字符串	新的转发到值。 返回：已更改 示例："/Common/dest1"
pool 字符串	新的池值。 返回：已更改 示例："/Common/pool1"
port 整数	新的端口值。 返回：已更改 示例：2020
protocol 字符串	新的协议值。 返回：已更改 示例："tcp"
服务器 SSL 配置文件 字符串	新的服务器 SSL 配置文件值。 返回：已更改 示例："/Common/serverssl"
syslog 格式 字符串	新的 Syslog 格式值。 返回：已更改 示例："syslog"
模板删除延迟 整数	新的模板删除延迟值。 返回：已更改 示例：20
模板重传间隔 整数	新的模板重传间隔值。 返回：已更改 示例：200
传输配置文件 字符串	新的传输配置文件值。 返回：已更改 示例："/Common/tcp"

作者

• Tim Rupp (@caphrim007)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）