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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 帮助管理 BIG-IP 系统上的简单网络管理协议 (SNMP) 社区。此模块支持不同的 SNMP 版本。请注意此模块提供的不同参数，因为不同的参数适用于不同版本的 SNMP。如果您混合使用 v2c 和 3 版本，这一点非常重要。

参数

参数	注释
access 字符串	指定用户对 MIB 的访问级别。 创建新社区时，如果未指定此参数，则默认为 ro。 当为 ro 时，指定用户可以查看 MIB，但不能修改 MIB。 当为 rw 时，指定用户可以查看和修改 MIB。 选项 "ro" "rw" "read-only" "read-write"
community 字符串	指定访问 MIB 的社区字符串（密码）。 此参数仅在 version 为 v1 或 v2c 时才相关。如果 version 为其他值，则忽略此参数。
ip_version 字符串	指定记录是否适用于 IPv4 或 IPv6 地址。 创建新社区时，如果未指定此值，则默认为 4。 此参数仅在 version 为 v1 或 v2c 时才相关。如果 version 为其他值，则忽略此参数。 选项 "4" "6"
name 字符串	标识 SNMP 社区的名称。 当 version 为 v1 或 v2c 时，此参数是必需的。 名称 public 是 BIG-IP 上的保留名称。此模块对该名称的处理方式与其他名称不同。从功能上讲，您不应该看到差异。
oid 字符串	指定记录的对象标识符 (OID)。 当 version 为 v3 时，此参数是必需的。 当 version 为 v1 或 v2c 时，如果指定此值，则 source 必须不设置为 all。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
port 整数	指定陷阱目标的端口。 此参数仅在 version 为 v1 或 v2c 时才相关。如果 version 为其他值，则忽略此参数。
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
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 ← (默认)
snmp_auth_password 字符串	指定用户的密码。 创建新的 SNMP v3 社区时，此参数是必需的。 此值必须至少为 8 个字符。
snmp_auth_protocol 字符串	指定用户的身份验证方法。 当使用md5时，指定系统使用MD5算法对用户进行身份验证。 当使用sha时，指定使用安全哈希算法(SHA)对用户进行身份验证。 当使用none时，指定用户不需要身份验证。 创建新的SNMP v3社区时，如果未指定此参数，则默认为sha。 选项 "md5" "sha" "none"
snmp_privacy_password 字符串	指定用户的密码。 创建新的 SNMP v3 社区时，此参数是必需的。 此值必须至少为 8 个字符。
snmp_privacy_protocol 字符串	指定加密协议。 当使用aes时，指定系统使用AES（高级加密标准）加密用户信息。 当使用des时，指定系统使用DES（数据加密标准）加密用户信息。 当使用none时，指定系统不加密用户信息。 创建新的SNMP v3社区时，如果未指定此参数，则默认为aes。 选项 "aes" "des" "none"
snmp_username 字符串	指定要授予其访问SNMP v3 MIB的用户名称。 此参数仅在version为v3时才相关。如果version为其他值，则忽略此参数。 创建新的 SNMP v3 社区时，此参数是必需的。 此参数一旦设置就不能更改。
source 字符串	指定访问MIB的源地址。 此参数可以接受值为all。 如果未指定此参数，则值为all。 此参数仅在 version 为 v1 或 v2c 时才相关。如果 version 为其他值，则忽略此参数。 如果将source设置为all，则无法指定oid。这将引发错误。 当state为absent时，应提供此参数，以便删除正确的社区。要删除BIG-IP附带的public SNMP社区，此参数应为default。
state 字符串	当为present时，确保地址列表和条目存在。 当为absent时，确保地址列表被删除。 选项 "present" ← (默认) "absent"
update_password 字符串	always允许用户更新密码。on_create仅为新创建的资源设置密码。 选项 "always" ← (默认) "on_create"
version 字符串	指定陷阱目标适用的SNMP版本。 选项 "v1" "v2c" ← (默认) "v3"

注释

注意

• 有关使用Ansible管理F5网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

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

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

示例

- name: Create an SMNP v2c read-only community
  bigip_snmp_community:
    name: foo
    version: v2c
    source: all
    oid: .1
    access: ro
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create an SMNP v3 read-write community
  bigip_snmp_community:
    name: foo
    version: v3
    snmp_username: foo
    snmp_auth_protocol: sha
    snmp_auth_password: secret
    snmp_privacy_protocol: aes
    snmp_privacy_password: secret
    oid: .1
    access: rw
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove the default 'public' SNMP community
  bigip_snmp_community:
    name: public
    source: default
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

Key	描述
access 字符串	MIB的新访问级别。 返回：changed 示例："ro"
community 字符串	新的社区值。 返回：changed 示例："community1"
ip_version 字符串	新的IP版本值。 返回：changed 示例："0.1"
oid 字符串	新的OID值。 返回：changed 示例："0.1"
snmp_auth_password 字符串	给定snmp_username的新密码。 返回：changed 示例："secret1"
snmp_auth_protocol 字符串	新的SNMP认证协议。 返回：changed 示例："sha"
snmp_privacy_password 字符串	给定snmp_username的新密码。 返回：changed 示例："secret2"
snmp_privacy_protocol 字符串	新的SNMP隐私协议。 返回：changed 示例："aes"
snmp_username 字符串	新的SNMP用户名。 返回：changed 示例："user1"
source 字符串	访问MIB的新源地址。 返回：changed 示例："1.1.1.1"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

资源链接

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