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 dictionary 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 ← (默认)
server_ssl_profile 字符串	如果transport_profile 是TCP配置文件，则可以使用此字段选择安全套接字层（SSL）配置文件，以将日志发送到IPFIX收集器。 SSL服务器配置文件定义了如何通过SSL或传输层安全（TLS）安全地进行通信。 此参数仅在type 为 ipfix 时可用。
state 字符串	当present时，确保资源存在。 当absent时，确保资源被删除。 选项 "present" ← (默认) "absent"
syslog_format 字符串	指定用于格式化与远程Syslog日志目标关联的日志的方法。 创建新的日志目标（并且type 为remote-syslog）时，如果未指定此参数，则默认为bsd-syslog。 syslog 和 rfc5424 选择项相同。 bsd-syslog 和 rfc3164 选择项相同。 选项 "bsd-syslog" "syslog" "legacy-bigip" "rfc5424" "rfc3164"
template_delete_delay 整数	输入BIG-IP设备在删除过时的IPFIX模板和重用其模板ID之间应暂停的时间（以秒为单位）。 此功能对于使用iRules创建自定义IPFIX模板的系统很有用。
template_retransmit_interval 整数	输入在将IPFIX模板传输到IPFIX收集器池之间的时间间隔（以秒为单位）。 日志目标会定期以您在此字段中设置的时间间隔重新传输其所有IPFIX模板。这些重新传输对于UDP（一种易失性传输机制）很有帮助。 此参数仅在type 为 ipfix 时可用。
transport_profile 字符串	基于TCP或UDP的传输配置文件。 此配置文件定义用于将IP流量日志发送到收集器池的TCP或UDP选项。 此参数仅在type 为 ipfix 时可用。
type 字符串 / 必需	指定日志目标的类型。 创建后，此参数无法更改。 选项 "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 字符串	新的地址值。 返回：changed 示例： "1.2.3.2"
distribution 字符串	新的分发方法值。 返回：changed 示例： "balanced"
forward_to 字符串	新的转发到值。 返回：changed 示例： "/Common/dest1"
pool 字符串	新的池值。 返回：changed 示例： "/Common/pool1"
port 整数	新的端口值。 返回：changed 示例： 2020
protocol 字符串	新的协议值。 返回：changed 示例： "tcp"
server_ssl_profile 字符串	新的服务器SSL配置文件值。 返回：changed 示例： "/Common/serverssl"
syslog_format 字符串	新的Syslog格式值。 返回：changed 示例： "syslog"
template_delete_delay 整数	新的模板删除延迟值。 返回：changed 示例： 20
template_retransmit_interval 整数	新的模板重传间隔值。 返回：changed 示例： 200
transport_profile 字符串	新的传输配置文件值。 返回：changed 示例： "/Common/tcp"

作者

• Tim Rupp (@caphrim007)

资源链接

• 问题追踪器
• 主页
• 代码库