Модуль arista.eos.eos_snmp_server — управление модулем ресурсов snmp_server

Примечание

Этот модуль входит в коллекцию arista.eos (версия 12.1.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install arista.eos.

Чтобы использовать модуль в плейбуке, укажите: arista.eos.eos_snmp_server.

Добавлено в arista.eos 3.2.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль настраивает атрибуты snmp_server и управляет ими на платформах Arista EOS.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: snmp_server

Параметры

Параметр	Комментарии
config dictionary	Конфигурация SNMP-сервера.
acls list / elements=dictionary	Списки контроля доступа IPv4/IPv6
acl string	Имя ACL
afi string	IPv4/IPv6 Варианты: `"ipv4"` `"ipv6"`
vrf string	Имя VRF
chassis_id string	Идентификатор шасси SNMP.
communities list / elements=dictionary	Настройка имени сообщества.
acl_v4 string	Имя стандартного списка контроля доступа
acl_v6 string	Имя списка контроля доступа IPv6.
name string	Имя сообщества
ro boolean	Разрешено только чтение. Варианты: `false` `true`
rw boolean	Доступ на чтение и запись Варианты: `false` `true`
view string	Имя представления MIB
contact string	Контактное лицо по вопросам системы.
engineid dictionary	Настройка идентификатора движка SNMPv3.
local string	Локальный агент SNMP
remote dictionary	Удалённый агент SNMP
host string	Имя узла или IP-адрес удалённого узла уведомлений SNMP
id string	Строка октетов идентификатора движка
udp_port integer	Номер UDP-порта удалённого узла уведомлений SNMP.
extension dictionary	Настройка скрипта расширения для обслуживания диапазона OID
oneshot boolean	Использовать неэффективный интерфейс one_shot Варианты: `false` `true`
root_oid string	Корневой OID расширения
script_location string	Расположение скрипта
groups list / elements=dictionary	Группа USM SNMP
auth_privacy string	Настройка аутентификации и конфиденциальности. Допустимо, если version = v3. Варианты: `"auth"` `"noauth"` `"priv"`
context string	Укажите контекст, связываемый с группой
group string	Группа SNMP для пользователя
notify string	Представление для ограничения уведомлений
read string	Представление для ограничения доступа на чтение
version string	Версия группы безопасности SNMP Варианты: `"v1"` `"v3"` `"v2c"`
write string	Представление для ограничения доступа на запись
hosts list / elements=dictionary	Адресаты уведомлений
host string	Имя узла или IP-адрес узла уведомлений SNMP.
informs boolean	Использовать информационные сообщения SNMP. Варианты: `false` `true`
traps boolean	Использовать сообщения-ловушки SNMP Варианты: `false` `true`
udp_port integer	Порт UDP назначения для сообщений уведомлений.
user string	Имя сообщества или пользователя.
version string	Версия SNMP для сообщений уведомлений. Варианты: `"1"` `"2c"` `"3 auth"` `"3 noauth"` `"3 priv"`
vrf string	Укажите VRF, в котором настроен узел
local_interface string	Настройка исходного интерфейса для уведомлений SNMP.
location string	Строка sysLocation.
notification integer	Максимальное количество уведомлений в журнале
objects dictionary	Если значение равно true, отключить реализацию группы объектов
mac_address_tables boolean	dot1dTpFdbTable, dot1qTpFdbTable Варианты: `false` `true`
route_tables boolean	ipCidrRouteTable, ipCidrRouteNumber, aristaFIBStats* Варианты: `false` `true`
qos integer	Настройка параметров QoS.
qosmib integer	Задать интервал обновления счётчиков QOS_MIB
transmit integer	Максимальное количество байтов в сообщении SNMP (полезная нагрузка UDP/TCP)
transport string	Включить протокол транспортного уровня snmpd
traps dictionary	Включить ловушки для всех настроенных получателей.
bgp dictionary	Включить ловушки BGP. Если задано значение enabled, будут включены все ловушки.
arista_backward_transition boolean	arista_backward_transition Варианты: `false` `true`
arista_established boolean	arista_established Варианты: `false` `true`
backward_transition boolean	backward_transition Варианты: `false` `true`
enabled boolean	Включены все ловушки. Варианты: `false` `true`
established boolean	Состояние established. Варианты: `false` `true`
bridge dictionary	Включить ловушки Bridge. Если задано значение enabled, будут включены все ловушки.
arista_mac_age boolean	arista_mac_age Варианты: `false` `true`
arista_mac_learn boolean	arista_mac_learn Варианты: `false` `true`
arista_mac_move boolean	arista_mac_move Варианты: `false` `true`
enabled boolean	Включены все ловушки. Варианты: `false` `true`
capacity dictionary	Включить ловушки Capacity. Если задано значение enabled, будут включены все ловушки.
arista_hardware_utilization_alert boolean	arista_hardware_utilization_alert Варианты: `false` `true`
enabled boolean	Включены все ловушки. Варианты: `false` `true`
entity dictionary	Включить ловушки Entity. Если задано значение enabled, будут включены все ловушки.
arista_ent_sensor_alarm boolean	arista_ent_sensor_alarm Варианты: `false` `true`

enabled boolean	Установлены все ловушки. Варианты: `false` `true`
ent_config_change boolean	ent_config_change Варианты: `false` `true`
ent_state_oper boolean	ent_state_oper Варианты: `false` `true`
ent_state_oper_disabled boolean	ent_state_oper_disabled. Варианты: `false` `true`
ent_state_oper_enabled boolean	ent_state_oper_enabled. Варианты: `false` `true`
external_alarm dictionary	Включить ловушки внешней сигнализации. Если задано значение enabled, устанавливаются все ловушки.
arista_external_alarm_asserted_notif boolean	arista_external_alarm_asserted_notif Варианты: `false` `true`
arista_external_alarm_deasserted_notif boolean	arista_external_alarm_deasserted_notif Варианты: `false` `true`
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
isis dictionary	Включить ловушки IS-IS. Если задано значение enabled, устанавливаются все ловушки.
adjacency_change boolean	adjacency_change Варианты: `false` `true`
area_mismatch boolean	area_mismatch Варианты: `false` `true`
attempt_to_exceed_max_sequence boolean	attempt_to_exceed_max_sequence Варианты: `false` `true`
authentication_type_failure boolean	authentication_type_failure. Варианты: `false` `true`
database_overload boolean	database_overload Варианты: `false` `true`
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
own_lsp_purge boolean	own_lsp_purge Варианты: `false` `true`
rejected_adjacency boolean	rejected_adjacency Варианты: `false` `true`
sequence_number_skip boolean	sequence_number_skip. Варианты: `false` `true`
lldp dictionary	Включить ловушки LLDP. Если задано значение enabled, устанавливаются все ловушки.
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
rem_tables_change boolean	rem_tables_change Варианты: `false` `true`
mpls_ldp dictionary	Включить ловушки MPLS LDP. Если задано значение enabled, устанавливаются все ловушки.
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
mpls_ldp_session_down boolean	mpls_ldp_session_down Варианты: `false` `true`
mpls_ldp_session_up boolean	mpls_ldp_session_up Варианты: `false` `true`
msdp dictionary	Включить ловушки MSDP. Если задано значение enabled, устанавливаются все ловушки.
backward_transition boolean	backward_transition. Варианты: `false` `true`
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
established boolean	established. Варианты: `false` `true`
ospf dictionary	Включить ловушки OSPF. Если задано значение enabled, устанавливаются все ловушки.
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
if_auth_failure boolean	if_auth_failure Варианты: `false` `true`
if_config_error boolean	if_config_error Варианты: `false` `true`
if_state_change boolean	if_state_change Варианты: `false` `true`
nbr_state_change boolean	nbr_state_change. Варианты: `false` `true`
ospfv3 dictionary	Включить ловушки OSPFv3. Если задано значение enabled, устанавливаются все ловушки.
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
if_config_error boolean	if_config_error Варианты: `false` `true`
if_rx_bad_packet boolean	if_rx_bad_packet Варианты: `false` `true`
if_state_change boolean	if_state_change Варианты: `false` `true`
nbr_restart_helper_status_change boolean	Включить ловушку ospfv3NbrRestartHelperStatusChange Варианты: `false` `true`
nbr_state_change boolean	nbr_state_change. Варианты: `false` `true`
nssa_translator_status_change boolean	Включить ловушку ospfv3NssaTranslatorStatusChange Варианты: `false` `true`
restart_status_change boolean	restart_status_change Варианты: `false` `true`
pim dictionary	Включить ловушки PIM. Если задано значение enabled, устанавливаются все ловушки.
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
neighbor_loss boolean	neighbor_loss Варианты: `false` `true`
snmp dictionary	Включить ловушки SNMP. Если задано значение enabled, устанавливаются все ловушки.
authentication boolean	authentication Варианты: `false` `true`
enabled boolean	Установлены все ловушки. Варианты: `false` `true`
link_down boolean	link_down Варианты: `false` `true`
link_up boolean	link_up Варианты: `false` `true`
snmpConfigManEvent dictionary	Включить ловушки snmpConfigManEvent. Если задано значение enabled, устанавливаются все ловушки.
arista_config_man_event boolean	arista_config_man_event Варианты: `false` `true`
enabled boolean	Установлены все ловушки. Варианты: `false` `true`

switchover dictionary	Включить traps переключения. Если задать значение enabled, будут настроены все traps.
arista_redundancy_switch_over_notif boolean	arista_redundancy_switch_over_notif Допустимые значения: `false` `true`
enabled boolean	Настраиваются все traps. Допустимые значения: `false` `true`
test dictionary	Включить тестовые traps. Если задать значение enabled, будут настроены все traps.
arista_test_notification boolean	arista_test_notification Допустимые значения: `false` `true`
enabled boolean	Настраиваются все traps. Допустимые значения: `false` `true`
vrrp dictionary	Включить traps VRRP. Если задать значение enabled, будут настроены все traps.
enabled boolean	Настраиваются все traps. Допустимые значения: `false` `true`
trap_new_master boolean	VRRP Допустимые значения: `false` `true`
users list / elements=dictionary	Настройка пользователей SNMP.
auth dictionary	Настройки аутентификации пользователя
algorithm string	Алгоритм аутентификации
auth_passphrase string	Шестнадцатеричная строка парольной фразы аутентификации
encryption string	Алгоритм шифрования.
priv_passphrase string	Шестнадцатеричная строка парольной фразы конфиденциальности
group string	Группа SNMP для пользователя.
localized dictionary	Локализованные парольные фразы аутентификации и конфиденциальности.
algorithm string	Алгоритм аутентификации
auth_passphrase string	Шестнадцатеричная строка парольной фразы аутентификации
encryption string	Алгоритм шифрования.
engineid string	Идентификатор движка
priv_passphrase string	Шестнадцатеричная строка парольной фразы конфиденциальности
remote string	Система, на которой размещен пользователь SNMPv3
udp_port integer	Порт UDP, используемый удаленной системой SNMP
user string	Имя пользователя SNMP
version string	Версия безопасности SNMP Допустимые значения: `"v1"` `"v2c"` `"v3"`
views list / elements=dictionary	Настройка представления MIB SNMPv2
action string	Выполняемое действие. Допустимые значения: `"excluded"` `"included"`
mib string	Имя MIB SNMP
view string	Имя представления SNMP
vrfs list / elements=dictionary	Укажите VRF, в котором используется исходный адрес
local_interface string	Настройте исходный интерфейс для уведомлений SNMP
vrf string	Имя VRF.
running_config string	Этот параметр используется только при значении состояния parsed. Значением этого параметра должны быть данные, полученные от устройства EOS при выполнении команды show running_config \| section snmp_server. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурса; затем значение возвращается в ключе parsed результата.
state string	Состояние, в котором должна остаться конфигурация. Состояния replaced и overridden работают в этом модуле одинаково. Дополнительные сведения см. в примерах. Допустимые значения: `"deleted"` `"merged"` ← (по умолчанию) `"overridden"` `"replaced"` `"gathered"` `"rendered"` `"parsed"`

Примечания

Примечание

Проверено на Arista EOS 4.24.6F
Этот модуль работает с подключениями network_cli и httpapi.

Примеры

# Using merged:

# Before State
# eos#show running-config | section snmp-server
# eos#

- name: merge given snmp_server configuration
  arista.eos.eos_snmp_server:
    config:
      communities:
        - name: "comm3"
          acl_v6: "list1"
          view: "view1"
        - name: "comm4"
          acl_v4: "list3"
          view: "view1"
        - name: "comm5"
          acl_v4: "list4"
          ro: true
      contact: "admin"
      engineid:
        remote:
          host: 1.1.1.1
          id: "1234567"
      groups:
        - group: "group1"
          version: "v1"
          read: "view1"
        - group: "group2"
          version: "v3"
          auth_privacy: "priv"
          notify: "view1"
          write: "view2"
      hosts:
        - host: "host02"
          user: "user01"
          udp_port: 23
          version: "2c"
        - host: "host01"
          user: "user01"
          udp_port: 23
          version: "3 priv"
      traps:
        capacity:
          arista_hardware_utilization_alert: true
        bgp:
          enabled: true
        external_alarm:
          arista_external_alarm_deasserted_notif: true
          arista_external_alarm_asserted_notif: true
      vrfs:
        - vrf: "vrf01"
          local_interface: "Ethernet1"

# After state
# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community comm4 view view1 list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server contact admin
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif
#
# Module Execution
#
# "after": {
#         "communities": [
#             {
#                 "acl_v6": "list1",
#                 "name": "comm3",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list3",
#                 "name": "comm4",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list4",
#                 "name": "comm5",
#                 "ro": true
#             }
#         ],
#         "contact": "admin",
#         "groups": [
#             {
#                 "group": "group1",
#                 "read": "view1",
#                 "version": "v1"
#             },
#             {
#                 "auth_privacy": "priv",
#                 "group": "group2",
#                 "notify": "view1",
#                 "version": "v3",
#                 "write": "view2"
#             }
#         ],
#         "hosts": [
#             {
#                 "host": "host01",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "3 priv"
#             },
#             {
#                 "host": "host02",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "2c"
#             }
#         ],
#         "traps": {
#             "bgp": {
#                 "enabled": true
#             },
#             "capacity": {
#                 "arista_hardware_utilization_alert": true
#             },
#             "external_alarm": {
#                 "arista_external_alarm_asserted_notif": true,
#                 "arista_external_alarm_deasserted_notif": true
#             }
#         },
#         "vrfs": [
#             {
#                 "local_interface": "Ethernet1",
#                 "vrf": "vrf01"
#             }
#         ]
#     },
#     "before": {},
#     "changed": true,
#     "commands": [
#         "snmp-server community comm3 view view1 ipv6 list1",
#         "snmp-server community comm4 view view1 list3",
#         "snmp-server community comm5 ro list4",
#         "snmp-server group group1 v1 read view1",
#         "snmp-server group group2 v3 priv write view2 notify view1",
#         "snmp-server host host02 version 2c user01 udp-port 23",
#         "snmp-server host host01 version 3 priv user01 udp-port 23",
#         "snmp-server vrf vrf01 local-interface Ethernet1",
#         "snmp-server contact admin",
#         "snmp-server engineID remote 1.1.1.1 1234567",
#         "snmp-server enable traps bgp",
#         "snmp-server enable traps capacity arista-hardware-utilization-alert",
#         "snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif"
#     ],
#

# Using replaced:

# Before State:
# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community comm4 view view1 list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server contact admin
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif

- name: Replace given snmp_server configuration
  become: true
  register: result
  arista.eos.eos_snmp_server: &replaced
    state: replaced
    config:
      communities:
        - name: "comm3"
          acl_v6: "list1"
          view: "view1"
        - name: "replacecomm"
          acl_v4: "list4"
      extension:
        root_oid: "123456"
        script_location: "flash:"
      traps:
        test:
          arista_test_notification: true
        bgp:
          enabled: true
      vrfs:
        - vrf: "vrf_replace"
          local_interface: "Ethernet1"

# After State:

# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community replacecomm list4
# snmp-server vrf vrf_replace local-interface Ethernet1
# snmp-server extension 123456 flash:
# snmp-server enable traps test arista-test-notification
# snmp-server enable traps bgp

# Module Execution:
#    "after": {
#        "communities": [
#            {
#                "acl_v6": "list1",
#                "name": "comm3",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list4",
#                "name": "replacecomm",
#                "ro": true
#            }
#        ],
#        "extension": {
#            "root_oid": "0.123456",
#            "script_location": "flash:"
#        },
#        "traps": {
#            "bgp": {
#                "enabled": true
#            },
#            "test": {
#                "arista_test_notification": true
#            }
#        },
#        "vrfs": [
#            {
#                "local_interface": "Ethernet1",
#                "vrf": "vrf_replace"
#            }
#        ]
#    },
#    "before": {
#        "communities": [
#            {
#                "acl_v6": "list1",
#                "name": "comm3",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list3",
#                "name": "comm4",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list4",
#                "name": "comm5",
#                "ro": true
#            }
#        ],
#        "contact": "admin",
#        "groups": [
#            {
#                "group": "group1",
#                "read": "view1",
#                "version": "v1"
#            },
#            {
#                "auth_privacy": "priv",
#                "group": "group2",
#                "notify": "view1",
#                "version": "v3",
#                "write": "view2"
#            }
#        ],
#        "hosts": [
#            {
#                "host": "host01",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "3 priv"
#            },
#            {
#                "host": "host02",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "2c"
#            }
#        ],
#        "traps": {
#            "bgp": {
#                "enabled": true
#            },
#            "capacity": {
#                "arista_hardware_utilization_alert": true
#            },
#            "external_alarm": {
#                "arista_external_alarm_asserted_notif": true,
#                "arista_external_alarm_deasserted_notif": true
#            }
#        },
#        "vrfs": [
#            {
#                "local_interface": "Ethernet1",
#                "vrf": "vrf01"
#            }
#        ]
#    },
#    "changed": true,
#    "commands": [
#        "snmp-server community comm3 view view1 ipv6 list1",
#        "snmp-server community replacecomm list4",
#        "no snmp-server community comm4 view view1 ro list3",
#        "no snmp-server community comm5 ro list4",
#        "no snmp-server group group1 v1 read view1",
#        "no snmp-server group group2 v3 priv write view2 notify view1",
#        "no snmp-server host host01 version 3 priv user01 udp-port 23",
#        "no snmp-server host host02 version 2c user01 udp-port 23",
#        "snmp-server vrf vrf_replace local-interface Ethernet1",
#        "no snmp-server vrf vrf01 local-interface Ethernet1",
#        "snmp-server extension 123456 flash:",
#        "default snmp-server enable traps capacity arista-hardware-utilization-alert",
#        "default snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif",
#        "snmp-server enable traps test arista-test-notification",
#        "no snmp-server contact admin"
#    ],

# Using overridden:
# Before State:
# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community comm4 view view1 list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server contact admin
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif

- name: Override given snmp_server configuration
  arista.eos.eos_snmp_server:
    state: overridden
    config:
      communities:
        - name: "comm3"
          acl_v6: "list1"
          view: "view1"
        - name: "replacecomm"
          acl_v4: "list4"
      extension:
        root_oid: "123456"
        script_location: "flash:"
      traps:
        test:
          arista_test_notification: true
        bgp:
          enabled: true
      vrfs:
        - vrf: "vrf_replace"
          local_interface: "Ethernet1"

# After State:

# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community replacecomm list4
# snmp-server vrf vrf_replace local-interface Ethernet1
# snmp-server extension 123456 flash:
# snmp-server enable traps test arista-test-notification
# snmp-server enable traps bgp

# Module Execution:
#    "after": {
#        "communities": [
#            {
#                "acl_v6": "list1",
#                "name": "comm3",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list4",
#                "name": "replacecomm",
#                "ro": true
#            }
#        ],
#        "extension": {
#            "root_oid": "0.123456",
#            "script_location": "flash:"
#        },
#        "traps": {
#            "bgp": {
#                "enabled": true
#            },
#            "test": {
#                "arista_test_notification": true
#            }
#        },
#        "vrfs": [
#            {
#                "local_interface": "Ethernet1",
#                "vrf": "vrf_replace"
#            }
#        ]
#    },
#    "before": {
#        "communities": [
#            {
#                "acl_v6": "list1",
#                "name": "comm3",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list3",
#                "name": "comm4",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list4",
#                "name": "comm5",
#                "ro": true
#            }
#        ],
#        "contact": "admin",
#        "groups": [
#            {
#                "group": "group1",
#                "read": "view1",
#                "version": "v1"
#            },
#            {
#                "auth_privacy": "priv",
#                "group": "group2",
#                "notify": "view1",
#                "version": "v3",
#                "write": "view2"
#            }
#        ],
#        "hosts": [
#            {
#                "host": "host01",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "3 priv"
#            },
#            {
#                "host": "host02",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "2c"
#            }
#        ],
#        "traps": {
#            "bgp": {
#                "enabled": true
#            },
#            "capacity": {
#                "arista_hardware_utilization_alert": true
#            },
#            "external_alarm": {
#                "arista_external_alarm_asserted_notif": true,
#                "arista_external_alarm_deasserted_notif": true
#            }
#        },
#        "vrfs": [
#            {
#                "local_interface": "Ethernet1",
#                "vrf": "vrf01"
#            }
#        ]
#    },
#    "changed": true,
#    "commands": [
#        "snmp-server community comm3 view view1 ipv6 list1",
#        "snmp-server community replacecomm list4",
#        "no snmp-server community comm4 view view1 ro list3",
#        "no snmp-server community comm5 ro list4",
#        "no snmp-server group group1 v1 read view1",
#        "no snmp-server group group2 v3 priv write view2 notify view1",
#        "no snmp-server host host01 version 3 priv user01 udp-port 23",
#        "no snmp-server host host02 version 2c user01 udp-port 23",
#        "snmp-server vrf vrf_replace local-interface Ethernet1",
#        "no snmp-server vrf vrf01 local-interface Ethernet1",
#        "snmp-server extension 123456 flash:",
#        "default snmp-server enable traps capacity arista-hardware-utilization-alert",
#        "default snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif",
#        "snmp-server enable traps test arista-test-notification",
#        "no snmp-server contact admin"
#    ],

# Using deleted:
# Before State:
# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community comm4 view view1 list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server contact admin
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif

- name: Delete given snmp_server configuration
  arista.eos.eos_snmp_server:
    state: deleted

# After State:
# eos#show running-config | section snmp-server
#

# Module Execution:
#   "after": {},
#    "before": {
#        "communities": [
#            {
#                "acl_v6": "list1",
#                "name": "comm3",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list3",
#                "name": "comm4",
#                "ro": true,
#                "view": "view1"
#            },
#            {
#                "acl_v4": "list4",
#                "name": "comm5",
#                "ro": true
#            }
#        ],
#        "contact": "admin",
#        "groups": [
#            {
#                "group": "group1",
#                "read": "view1",
#                "version": "v1"
#            },
#            {
#                "auth_privacy": "priv",
#                "group": "group2",
#                "notify": "view1",
#                "version": "v3",
#                "write": "view2"
#            }
#        ],
#        "hosts": [
#            {
#                "host": "host01",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "3 priv"
#            },
#            {
#                "host": "host02",
#                "udp_port": 23,
#                "user": "user01",
#                "version": "2c"
#            }
#        ],
#        "traps": {
#            "bgp": {
#                "enabled": true
#            },
#            "capacity": {
#                "arista_hardware_utilization_alert": true
#            },
#            "external_alarm": {
#                "arista_external_alarm_asserted_notif": true,
#                "arista_external_alarm_deasserted_notif": true
#            }
#        },
#        "vrfs": [
#            {
#                "local_interface": "Ethernet1",
#                "vrf": "vrf01"
#            }
#        ]
#    },
#    "changed": true,
#    "commands": [
#        "no snmp-server community comm3 view view1 ro ipv6 list1",
#        "no snmp-server community comm4 view view1 ro list3",
#        "no snmp-server community comm5 ro list4",
#        "no snmp-server group group1 v1 read view1",
#        "no snmp-server group group2 v3 priv write view2 notify view1",
#        "no snmp-server host host01 version 3 priv user01 udp-port 23",
#        "no snmp-server host host02 version 2c user01 udp-port 23",
#        "no snmp-server vrf vrf01 local-interface Ethernet1",
#        "no snmp-server contact admin",
#        "default snmp-server enable traps bgp",
#        "default snmp-server enable traps capacity arista-hardware-utilization-alert",
#        "default snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif"
#    ],
#

# Using parsed:

# _parsed.cfg
# snmp-server contact admin
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server community comm3 view view1 ro ipv6 list1
# snmp-server community comm4 view view1 ro list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif
# snmp-server enable traps external-alarm arista-external-alarm-deasserted-notif

- name: Provide the running configuration for parsing (config to be parsed)
  arista.eos.eos_snmp_server:
    running_config: "{{ lookup('file', '_parsed.cfg') }}"
    state: parsed

# Module Execution:
#     "parsed": {
#         "communities": [
#             {
#                 "acl_v6": "list1",
#                 "name": "comm3",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list3",
#                 "name": "comm4",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list4",
#                 "name": "comm5",
#                 "ro": true
#             }
#         ],
#         "contact": "admin",
#         "groups": [
#             {
#                 "group": "group1",
#                 "read": "view1",
#                 "version": "v1"
#             },
#             {
#                 "auth_privacy": "priv",
#                 "group": "group2",
#                 "notify": "view1",
#                 "version": "v3",
#                 "write": "view2"
#             }
#         ],
#         "hosts": [
#             {
#                 "host": "host01",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "3 priv"
#             },
#             {
#                 "host": "host02",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "2c"
#             }
#         ],
#         "traps": {
#             "bgp": {
#                 "enabled": true
#             },
#             "capacity": {
#                 "arista_hardware_utilization_alert": true
#             },
#             "external_alarm": {
#                 "arista_external_alarm_asserted_notif": true,
#                 "arista_external_alarm_deasserted_notif": true
#             }
#         },
#         "vrfs": [
#             {
#                 "local_interface": "Ethernet1",
#                 "vrf": "vrf01"
#             }
#         ]
#   }

# Using rendered:
- name: Render given snmp_server configuration
  arista.eos.eos_snmp_server:
    state: "rendered"
    config:
      communities:
        - name: "comm3"
          acl_v6: "list1"
          view: "view1"
        - name: "comm4"
          acl_v4: "list3"
          view: "view1"
        - name: "comm5"
          acl_v4: "list4"
          ro: true
      contact: "admin"
      engineid:
        remote:
          host: 1.1.1.1
          id: "1234567"
      groups:
        - group: "group1"
          version: "v1"
          read: "view1"
        - group: "group2"
          version: "v3"
          auth_privacy: "priv"
          notify: "view1"
          write: "view2"
      hosts:
        - host: "host02"
          user: "user01"
          udp_port: 23
          version: "2c"
        - host: "host01"
          user: "user01"
          udp_port: 23
          version: "3 priv"
      traps:
        capacity:
          arista_hardware_utilization_alert: true
        bgp:
          enabled: true
        external_alarm:
          arista_external_alarm_deasserted_notif: true
          arista_external_alarm_asserted_notif: true
      vrfs:
        - vrf: "vrf01"
          local_interface: "Ethernet1"

# Module Execution:
#    "rendered": [
#        "snmp-server community comm3 view view1 ipv6 list1",
#        "snmp-server community comm4 view view1 list3",
#        "snmp-server community comm5 ro list4",
#        "snmp-server group group1 v1 read view1",
#        "snmp-server group group2 v3 priv write view2 notify view1",
#        "snmp-server host host02 version 2c user01 udp-port 23",
#        "snmp-server host host01 version 3 priv user01 udp-port 23",
#        "snmp-server vrf vrf01 local-interface Ethernet1",
#        "snmp-server contact admin",
#        "snmp-server engineID remote 1.1.1.1 1234567",
#        "snmp-server enable traps bgp",
#        "snmp-server enable traps capacity arista-hardware-utilization-alert",
#        "snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif"
#    ]

# using gathered:

# eos#show running-config | section snmp-server
# snmp-server community comm3 view view1 ipv6 list1
# snmp-server community comm4 view view1 list3
# snmp-server community comm5 ro list4
# snmp-server group group1 v1 read view1
# snmp-server group group2 v3 priv write view2 notify view1
# snmp-server host host02 version 2c user01 udp-port 23
# snmp-server host host01 version 3 priv user01 udp-port 23
# snmp-server vrf vrf01 local-interface Ethernet1
# snmp-server contact admin
# snmp-server enable traps bgp
# snmp-server enable traps capacity arista-hardware-utilization-alert
# snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif

- name: Gathered the provided configuration with the exisiting running configuration
  arista.eos.eos_snmp_server:
    config:
    state: gathered

# Module Execution:
#     "gathered": {
#         "communities": [
#             {
#                 "acl_v6": "list1",
#                 "name": "comm3",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list3",
#                 "name": "comm4",
#                 "ro": true,
#                 "view": "view1"
#             },
#             {
#                 "acl_v4": "list4",
#                 "name": "comm5",
#                 "ro": true
#             }
#         ],
#         "contact": "admin",
#         "groups": [
#             {
#                 "group": "group1",
#                 "read": "view1",
#                 "version": "v1"
#             },
#             {
#                 "auth_privacy": "priv",
#                 "group": "group2",
#                 "notify": "view1",
#                 "version": "v3",
#                 "write": "view2"
#             }
#         ],
#         "hosts": [
#             {
#                 "host": "host01",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "3 priv"
#             },
#             {
#                 "host": "host02",
#                 "udp_port": 23,
#                 "user": "user01",
#                 "version": "2c"
#             }
#         ],
#         "traps": {
#             "bgp": {
#                 "enabled": true
#             },
#             "capacity": {
#                 "arista_hardware_utilization_alert": true
#             },
#             "external_alarm": {
#                 "arista_external_alarm_asserted_notif": true,
#                 "arista_external_alarm_deasserted_notif": true
#             }
#         },
#         "vrfs": [
#             {
#                 "local_interface": "Ethernet1",
#                 "vrf": "vrf01"
#             }
#         ]
#     },

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, специфичные для этого модуля:

Ключ	Описание
after dictionary	Конфигурация после выполнения модуля. Возвращается: при наличии изменений Пример: `"This output will always be in the same format as the module argspec.\n"`
before dictionary	Конфигурация до выполнения модуля. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands list / elements=string	Набор команд, отправленных на удаленное устройство. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: ["snmp-server community comm3 view view1 ipv6 list1", "snmp-server community comm4 view view1 list3", "snmp-server community comm5 ro list4", "snmp-server group group1 v1 read view1", "snmp-server group group2 v3 priv write view2 notify view1", "snmp-server host host02 version 2c user01 udp-port 23", "snmp-server host host01 version 3 priv user01 udp-port 23", "snmp-server vrf vrf01 local-interface Ethernet1", "snmp-server contact admin", "snmp-server engineID remote 1.1.1.1 1234567", "snmp-server enable traps bgp", "snmp-server enable traps capacity arista-hardware-utilization-alert", "snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif"]
gathered list / elements=string	Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: когда state имеет значение `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed list / elements=string	Собственная конфигурация устройства, переданная в параметре running_config и разобранная в структурированные данные в соответствии со спецификацией аргументов модуля. Возвращается: когда state имеет значение `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered list / elements=string	Конфигурация из задачи, преобразованная в собственный формат устройства (автономный режим). Возвращается: когда state имеет значение `rendered` Пример: ["snmp-server community comm3 view view1 ipv6 list1", "snmp-server community comm4 view view1 list3", "snmp-server community comm5 ro list4", "snmp-server group group1 v1 read view1", "snmp-server group group2 v3 priv write view2 notify view1", "snmp-server host host02 version 2c user01 udp-port 23", "snmp-server host host01 version 3 priv user01 udp-port 23", "snmp-server vrf vrf01 local-interface Ethernet1", "snmp-server contact admin", "snmp-server engineID remote 1.1.1.1 1234567", "snmp-server enable traps bgp", "snmp-server enable traps capacity arista-hardware-utilization-alert", "snmp-server enable traps external-alarm arista-external-alarm-asserted-notif arista-external-alarm-deasserted-notif"]

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/arista/eos/eos_snmp_server_module.html