f5networks.f5_modules.bigip_snmp 模块 – 在 BIG-IP 上操作通用 SNMP 设置

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 在 BIG-IP 系统上操作通用 SNMP 设置。

参数

参数

注释

agent_authentication_traps

字符串

enabled 时,确保系统将身份验证警告陷阱发送到陷阱目标。BIG-IP 上通常默认禁用此设置。

选项

  • "enabled"

  • "disabled"

agent_status_traps

字符串

enabled 时,确保系统在 SNMP 代理启动或停止运行时发送陷阱。BIG-IP 上通常默认启用此设置。

选项

  • "enabled"

  • "disabled"

allowed_addresses

任意

配置 snmpd 守护进程接受请求的 SNMP 客户端的 IP 地址。

此值可以是主机名、IP 地址或 IP 网络。

您可以指定单个列表项 default,将该值设置回系统默认值 127.0.0.0/8

您可以通过提供单词 none 或提供空字符串 "" 来删除所有允许的地址。

contact

字符串

指定为此系统管理 SNMP 服务的人员的姓名。

device_warning_traps

字符串

enabled 时,确保系统将设备警告陷阱发送到陷阱目标。BIG-IP 上通常默认启用此设置。

选项

  • "enabled"

  • "disabled"

location

字符串

指定此系统的物理位置的描述。

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

说明

注意

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

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

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

示例

- name: Set snmp contact
  bigip_snmp:
    contact: Joe User
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set snmp location
  bigip_snmp:
    location: US West 1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

描述

agent_authentication_traps

字符串

身份验证状态陷阱的值。

返回: changed

示例: "enabled"

agent_status_traps

字符串

代理状态陷阱的值。

返回: changed

示例: "enabled"

allowed_addresses

列表 / 元素=字符串

SNMP客户端连接的新允许地址。

返回: changed

示例: ["127.0.0.0/8", "foo.bar.com", "10.10.10.10"]

contact

字符串

设备上管理SNMP的人员的新值。

返回: changed

示例: "Joe User"

device_warning_traps

字符串

警告状态陷阱的值。

返回: changed

示例: "enabled"

location

字符串

系统物理位置的新值。

返回: changed

示例: "US West 1a"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)