f5networks.f5_modules.bigip_remote_syslog 模块 – 操作 BIG-IP 上的远程 syslog 设置

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

操作 BIG-IP 系统上的远程 syslog 设置。

参数 

参数	注释
local_ip 字符串	指定正在记录的系统的本地 IP 地址。要取消提供本地 IP，请指定值 `none`。创建远程 syslog 时，如果未指定此参数，则默认值为 `none`。
name 字符串	指定 syslog 对象的名称。当设备上存在具有相同 IP 或主机名的多个 `remote_host` 时，此选项是必需的。如果未提供 `name`，则默认使用 `remote_host`。
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` ← (默认)
remote_host 字符串 / 必需	指定系统将日志消息发送到的远程系统的 IP 地址或主机名。
remote_port 字符串	指定系统用于将消息发送到远程日志服务器的端口。创建远程 syslog 时，如果未指定此参数，则默认值为 `514`。
state 字符串	当为 `present` 时，确保远程 syslog 存在且具有提供的属性。当为 `absent` 时，从系统中删除远程 syslog。选项 `"absent"` `"present"` ← (默认)

备注 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块的文档以了解保存运行配置的正确使用方法。

示例 

- name: Add a remote syslog server to log to
  bigip_remote_syslog:
    remote_host: 10.10.10.10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add a remote syslog server on a non-standard port to log to
  bigip_remote_syslog:
    remote_host: 10.10.10.10
    remote_port: 1234
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
local_ip 字符串	远程 syslog 服务器的新本地 IP。返回：已更改示例： `"10.10.10.10"`
remote_port 整数	远程 syslog 服务器的新远程端口。返回：已更改示例： `514`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)