cisco.nxos.nxos_snmp_host 模块 – (已弃用,将于 2024-01-01 之后移除) 管理 SNMP 主机配置。

注意

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

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.nxos

要在剧本中使用它,请指定:cisco.nxos.nxos_snmp_host

cisco.nxos 1.0.0 中的新增功能

已弃用

在以下版本中移除:

2024-01-01 之后的主要版本

原因:

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

替代方案:

nxos_snmp_server

概要

  • 管理 SNMP 主机配置参数。

参数

参数

注释

community

字符串

社区字符串或 v3 用户名。

snmp_host

字符串 / 必需

目标主机的 IP 地址或主机名。

snmp_type

字符串

要发送到主机的消息类型。如果未指定,则使用 trap 类型。

选择

  • "trap"

  • "inform"

src_intf

字符串

源接口。必须是完全限定的接口名称。如果 state = absent,则删除该接口。

state

字符串

管理资源的状态。如果 state = present,则将主机添加到配置中。如果仅给出 vrf 和/或 vrf_filter 和/或 src_intf,则会将它们添加到现有主机配置中。如果 state = absent,则会在给出 community 参数的情况下删除主机。可以仅提供 vrf 和/或 src_int 和/或 vrf_filter 这些参数而不提供 community 参数来仅删除它们。

选择

  • "present" ← (默认)

  • "absent"

udp

字符串

UDP 端口号 (0-65535)。

默认值: "162"

v3

字符串

当版本为 v3 时使用。SNMPv3 安全级别。

选择

  • "noauth"

  • "auth"

  • "priv"

version

字符串

SNMP 版本。如果未指定,则使用 v1。

选择

  • "v1"

  • "v2c"

  • "v3"

vrf

字符串

用于将流量发送到源的 VRF。如果 state = absent,则删除该 vrf。

vrf_filter

字符串

要筛选的 VRF 的名称。如果 state = absent,则从筛选器中删除该 vrf。

注意

注意

  • 在 VIRL 上针对 NXOSv 7.3.(0)D1(1) 进行了测试

  • 对 Cisco MDS 的有限支持

  • 如果配置了 state=absent,则会删除主机配置。

  • 有关使用 CLI 和 NX-API 的信息,请参阅 :ref:`NXOS 平台选项指南 <nxos_platform_options>`

  • 有关使用 Ansible 管理网络设备的更多信息,请参阅 :ref:`Ansible 网络指南 <network_guide>`

  • 有关使用 Ansible 管理 Cisco 设备的更多信息,请参阅 “Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例

# ensure snmp host is configured
- cisco.nxos.nxos_snmp_host:
    snmp_host: 192.0.2.3
    community: TESTING
    state: present

返回值

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

描述

commands

列表 / elements=string

发送到设备的命令

已返回: 总是

示例: ["snmp-server host 192.0.2.3 filter-vrf another_test_vrf"]

状态

  • 此模块将在 2024-01-01 之后的主要版本中移除。[已弃用]

  • 有关更多信息,请参阅已弃用

作者

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)