cisco.meraki.meraki_snmp 模块 – 管理 Meraki 云中的组织

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.meraki。

要在剧本中使用它，请指定： cisco.meraki.meraki_snmp。

已弃用

在以下版本中移除：

版本 3.0.0

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.networks_snmp

摘要

• 允许管理 Meraki 的 SNMP 设置。

参数

参数	注释
access 字符串	SNMP 访问类型。 选项 "community" "none" "users"
auth_key 字符串 / 必填	仪表盘提供的身份验证密钥。如果环境变量 MERAKI_KEY 未设置，则需要此密钥。
community_string 字符串	SNMP 社区字符串。 仅当 access 设置为 community 时才相关。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	网络 ID。
net_name 字符串	网络名称。
org_id 字符串	组织 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法（例如 net_id）或驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
peer_ips 列表 / 元素=字符串	可以执行 SNMP 查询的 IP 地址列表。
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	指定是否应查询或修改 SNMP 信息。 选项 "query" "present" ← (默认)
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，它将使用 HTTP。否则，它将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，即使目标主机上的环境变量中定义了代理，它也不会使用代理。 选项 false ← (默认) true
users 列表 / 元素=字典	有关具有 SNMP 访问权限的用户的的信息。 仅当 access 设置为 users 时才相关。
passphrase 字符串	用户 SNMP 访问的密码。
username 字符串	具有访问权限的用户的用户名。
v2c_enabled 布尔值	指定是否启用 SNMPv2c。 选项 false true
v3_auth_mode 字符串	设置 SNMPv3 的身份验证模式。 选项 "MD5" "SHA"
v3_auth_pass 字符串	SNMPv3 的身份验证密码。 必须至少 8 个字符长。
v3_enabled 布尔值	指定是否启用 SNMPv3。 选项 false true
v3_priv_mode 字符串	指定 SNMPv3 的隐私模式。 选项 "DES" "AES128"
v3_priv_pass 字符串	SNMPv3 的隐私密码。 必须至少 8 个字符长。
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)

备注

注意

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的剧本。

• 检查模式会从仪表盘下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Query SNMP values
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Enable SNMPv2
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v2c_enabled: yes
  delegate_to: localhost

- name: Disable SNMPv2
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v2c_enabled: no
  delegate_to: localhost

- name: Enable SNMPv3
  meraki_snmp:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    v3_enabled: true
    v3_auth_mode: SHA
    v3_auth_pass: ansiblepass
    v3_priv_mode: AES128
    v3_priv_pass: ansiblepass
    peer_ips: 192.0.1.1;192.0.1.2
  delegate_to: localhost

- name: Set network access type to community string
  meraki_snmp:
    auth_key: abc1235
    org_name: YourOrg
    net_name: YourNet
    state: present
    access: community
    community_string: abc123
  delegate_to: localhost

- name: Set network access type to username
  meraki_snmp:
    auth_key: abc1235
    org_name: YourOrg
    net_name: YourNet
    state: present
    access: users
    users:
      - username: ansibleuser
        passphrase: ansiblepass
  delegate_to: localhost

返回值

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

键	描述
数据 复杂	有关 SNMP 设置的信息。 返回：始终
access 字符串	SNMP 访问类型。 返回：成功，当指定网络时
community_string 字符串	SNMP 社区字符串。仅当 access 设置为 community 时才相关。 返回：成功，当指定网络时
主机名 字符串	SNMP 服务器的主机名。 返回：成功且未指定网络。 示例： "n1.meraki.com"
peer_ips 字符串	可以轮询 SNMP 信息的 IP 地址的用分号分隔的列表。 返回：成功且未指定网络。 示例： "192.0.1.1"
端口 字符串	SNMP 的端口号。 返回：成功且未指定网络。 示例： "16100"
users 复杂	有关有权访问 SNMP 的用户信息。仅当 access 设置为 users 时才相关。 返回：成功
passphrase 字符串	用户 SNMP 访问的密码。 返回：成功，当指定网络时
username 字符串	具有访问权限的用户的用户名。 返回：成功，当指定网络时
v2_community_string 字符串	为 SNMPv2c 自动生成的社区字符串。 返回：当启用 SNMPv2c 且未指定网络时。 示例： "o/8zd-JaSb"
v2c_enabled 布尔值	显示 SNMPv2c 的启用状态 返回：成功且未指定网络。 示例： true
v3_auth_mode 字符串	SNMP 版本 3 身份验证模式，MD5 或 SHA。 返回：成功且未指定网络。 示例： "SHA"
v3_enabled 布尔值	显示 SNMPv3 的启用状态 返回：成功且未指定网络。 示例： true
v3_priv_mode 字符串	SNMP 版本 3 保密模式 DES 或 AES128。 返回：成功且未指定网络。 示例： "AES128"
v3_user 字符串	为 SNMPv3 自动生成的用户名。 返回：当启用 SNMPv3c 且未指定网络时。 示例： "o/8zd-JaSb"

状态

• 此模块将在 3.0.0 版本中删除。[已弃用]

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题追踪器
• 代码库 (源码)