f5networks.f5_modules.bigip_snmp_trap 模块 – 在 BIG-IP 上操作 SNMP trap 信息

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

在 BIG-IP 系统上操作 SNMP trap 信息。

参数 

参数	注释
auth_password 字符串在 f5networks.f5_modules 1.16.0 中添加	指定用于 snmp v3 trap 的身份验证协议密码当 `snmp_version` 与 `v3` 匹配，且当 `security_level` 匹配时，此参数是必需的。
auth_protocol 字符串在 f5networks.f5_modules 1.16.0 中添加	指定用于 snmp v3 trap 的身份验证协议当 `security_level` 匹配时，此参数是必需的。选择 `"sha"` `"md5"`
community 字符串	指定 trap 目标的 community 名称。
destination 字符串	指定 trap 目标的地址。这可以是 IP 地址或主机名。
name 字符串 / 必需	SNMP 配置端点的名称。
network 字符串	指定 trap 网络的名称。此选项在 12.1.0 之前的 BIG-IP 版本中不受支持，并且在这些版本上会被忽略。值 `default` 在 BIG-IP 版本 13.1.0 中已删除。在配置 BIG-IP 时指定此值会导致模块停止并报告错误。在这种情况下，请选择其他选项之一，例如 `management`。选择 `"other"` `"management"` `"default"`
partition 字符串	设备分区，用于管理资源。默认值: `"Common"`
port 字符串	指定 trap 目标的端口。
privacy_password 字符串在 f5networks.f5_modules 1.16.0 中添加	指定用于 snmp v3 trap 的隐私协议密码当 `security_level` 与 c(auth-privacy) 匹配时，此参数是必需的。
privacy_protocol 字符串在 f5networks.f5_modules 1.16.0 中添加	指定用于 snmp v3 trap 的隐私协议当 `security_level` 与 c(auth-privacy) 匹配时，此参数是必需的。选择 `"aes"` `"des"`
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` ← (默认值)
security_level 字符串在 f5networks.f5_modules 1.16.0 中添加	指定 trap 目标的端口。当 `snmp_version` 与 `v3` 匹配时，此参数是必需的。选择 `"auth-no-privacy"` `"auth-privacy"`
security_name 字符串在 f5networks.f5_modules 1.16.0 中添加	指定用于 v3 snmp trap 的安全名称当 `snmp_version` 与 `v3` 匹配时，此参数是必需的。
snmp_version 字符串	指定 trap 目标适用的简单网络管理协议 (SNMP) 版本。选择 `"1"` `"2c"` `"3"`
state 字符串	当为 `present` 时，确保资源存在。当为 `absent` 时，确保资源不存在。选择 `"present"` ← (默认值) `"absent"`

注释 

注意

此模块仅支持 SNMP 的 v1 和 v2c 版本。
在 12.1.0 之前的 BIG-IP 版本中不支持 network 选项，因为该平台直到 12.1.0 版本才支持该选项。如果在 12.1.0 之前的版本中使用，它将被简单地忽略。
有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久保存到磁盘，请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关如何正确使用该模块保存运行配置，请参阅该模块的文档。

示例 

- name: Create snmp v1 trap
  bigip_snmp_trap:
    community: general
    destination: 1.2.3.4
    name: my-trap1
    network: management
    port: 9000
    snmp_version: 1
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create snmp v2 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.8
    name: my-trap2
    network: default
    port: 7000
    snmp_version: 2c
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create snmp v3 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.9
    name: my-trap3
    network: management
    port: 7001
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test12345'
    security_name: "testsec2"
    security_level: "auth-no-privacy"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

- name: Create snmp v3 trap-2
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.10
    name: my-trap4
    network: management
    port: 7002
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test123456'
    security_name: "testsec3"
    security_level: "auth-privacy"
    privacy_protocol: "des"
    privacy_password: 'test@12345'
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

返回值 

通用返回值记录在此处这里，以下是此模块独有的字段

键	描述
community 列表 / 元素=字符串	陷阱目标的新 `community` 名称。返回: changed 和 success 示例: `["secret"]`
destination 字符串	以 IP 地址或主机名形式表示的陷阱目标的新地址。返回: changed 和 success 示例: `"1.2.3.4"`
network 字符串	SNMP 陷阱所在网络的新名称。返回: changed 和 success 示例: `"management"`
port 字符串	陷阱目标的新 `port`。返回: changed 和 success 示例: `"900"`
snmp_version 字符串	在远程设备上配置的新 `snmp_version`。返回: changed 和 success 示例: `"2c"`

作者

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