arista.eos.eos_snmp_server модуль — Управляет ресурсом snmp_server

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 словарь	Конфигурация сервера SNMP.
acls список / элементы=словарь	списки доступа ipv4/ipv6
acl строка	имя списка доступа
afi строка	ipv4/ipv6 Варианты: `"ipv4"` `"ipv6"`
vrf строка	имя vrf
chassis_id строка	Идентификатор узла SNMP.
communities список / элементы=словарь	Конфигурация имени сообщества.
acl_v4 строка	стандартное имя списка доступа
acl_v6 строка	имя списка доступа IPv6.
name строка	Имя сообщества
ro булево	Допускаются только операции чтения. Варианты: `false` `true`
rw булево	Доступ чтение-запись Варианты: `false` `true`
view строка	имя представления MIB
contact строка	Контактное лицо по системе.
engineid словарь	Конфигурация идентификатора узла SNMPv3.
local строка	Локальный агент SNMP
remote словарь	Удаленный агент SNMP
host строка	Имя хоста или IP-адрес удалённого хоста уведомлений SNMP
id строка	строка octet идентификатора узла
udp_port целое число	Номер UDP-порта удалённого хоста уведомлений SNMP.
extension словарь	Настройка скрипта расширения для обслуживания диапазона OID
oneshot булево	Использовать неэффективный интерфейс one_shot Варианты: `false` `true`
root_oid строка	Корневой OID расширения
script_location строка	Расположение скрипта
groups список / элементы=словарь	Группа SNMP USM
auth_privacy строка	Конфигурация аутентификации и конфиденциальности. Действительно, когда version = v3. Варианты: `"auth"` `"noauth"` `"priv"`
context строка	Укажите контекст для ассоциации с группой

END_OF_DOCUMENT_MARKER

group string	Группа SNMP для пользователя
notify string	Представление для ограничения уведомлений
read string	Представление для ограничения доступа на чтение
version string	Версия группы безопасности snmp Choices: `"v1"` `"v3"` `"v2c"`
write string	Представление для ограничения доступа на запись
hosts list / elements=dictionary	Пункты назначения уведомлений
host string	Имя хоста или IP-адрес хоста уведомлений SNMP.
informs boolean	Использовать сообщения SNMP inform. Choices: `false` `true`
traps boolean	Использовать сообщения SNMP trap Choices: `false` `true`
udp_port integer	Целевой UDP-порт для сообщений уведомлений.
user string	Имя сообщества или пользователя.
version string	Версия SNMP для сообщения уведомления. Choices: `"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 Choices: `false` `true`
route_tables boolean	ipCidrRouteTable, ipCidrRouteNumber, aristaFIBStats* Choices: `false` `true`
qos integer	Настройка параметров QoS.
qosmib integer	Установка интервала обновления счетчика QOS_MIB
transmit integer	Максимальное количество байтов в сообщении SNMP (полезная нагрузка UDP/TCP)
transport string	Включение протокола транспортного уровня snmpd
traps dictionary	Включение traps для всех настроенных получателей.
bgp dictionary	Включение Bgp traps. Если установлено значение enabled, то устанавливаются все traps.

arista_backward_transition boolean	arista_backward_transition Choices: `false` `true`
arista_established boolean	arista_established Choices: `false` `true`
backward_transition boolean	backward_transition Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
established boolean	established. Choices: `false` `true`
bridge dictionary	Включить ловушки Bridge. Если установлено значение enabled, устанавливаются все ловушки.
arista_mac_age boolean	arista_mac_age Choices: `false` `true`
arista_mac_learn boolean	arista_mac_learn Choices: `false` `true`
arista_mac_move boolean	arista_mac_move Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
capacity dictionary	Включить ловушки Capacity. Если установлено значение enabled, устанавливаются все ловушки.
arista_hardware_utilization_alert boolean	arista_hardware_utilization_alert Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
entity dictionary	Включить ловушки Entity. Если установлено значение enabled, устанавливаются все ловушки.
arista_ent_sensor_alarm boolean	arista_ent_sensor_alarm Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
ent_config_change boolean	ent_config_change Choices: `false` `true`
ent_state_oper boolean	ent_state_oper Choices: `false` `true`
ent_state_oper_disabled boolean	ent_state_oper_disabled. Choices: `false` `true`
ent_state_oper_enabled boolean	ent_state_oper_enabled. Choices: `false` `true`

external_alarm dictionary	Включить внешние ловушки тревоги. Если установлено значение enabled, устанавливаются все ловушки.
arista_external_alarm_asserted_notif boolean	arista_external_alarm_asserted_notif Choices: `false` `true`
arista_external_alarm_deasserted_notif boolean	arista_external_alarm_deasserted_notif Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
isis dictionary	Включить ловушки ISIS. Если установлено значение enabled, устанавливаются все ловушки.
adjacency_change boolean	adjacency_change Choices: `false` `true`
area_mismatch boolean	area_mismatch Choices: `false` `true`
attempt_to_exceed_max_sequence boolean	attempt_to_exceed_max_sequence Choices: `false` `true`
authentication_type_failure boolean	authentication_type_failure. Choices: `false` `true`
database_overload boolean	database_overload Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
own_lsp_purge boolean	own_lsp_purge Choices: `false` `true`
rejected_adjacency boolean	rejected_adjacency Choices: `false` `true`
sequence_number_skip boolean	sequence_number_skip. Choices: `false` `true`
lldp dictionary	Включить ловушки LLDP. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Все ловушки установлены. Choices: `false` `true`
rem_tables_change boolean	rem_tables_change Choices: `false` `true`
mpls_ldp dictionary	Включить ловушки MPLS LDP. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Все ловушки установлены. Choices: `false` `true`
mpls_ldp_session_down boolean	mpls_ldp_session_down Choices: `false` `true`

mpls_ldp_session_up boolean	mpls_ldp_session_up Choices: `false` `true`
msdp dictionary	Включить ловушки msdp. Если установлено значение enabled, устанавливаются все ловушки.
backward_transition boolean	backward_transition. Choices: `false` `true`
enabled boolean	Все ловушки установлены. Choices: `false` `true`
established boolean	established. Choices: `false` `true`
ospf dictionary	Включить ловушки Ospf. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Все ловушки установлены. Choices: `false` `true`
if_auth_failure boolean	if_auth_failure Choices: `false` `true`
if_config_error boolean	if_config_error Choices: `false` `true`
if_state_change boolean	if_state_change Choices: `false` `true`
nbr_state_change boolean	nbr_state_change. Choices: `false` `true`
ospfv3 dictionary	Включить ловушки Ospfv3. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Все ловушки установлены. Choices: `false` `true`
if_config_error boolean	if_config_error Choices: `false` `true`
if_rx_bad_packet boolean	if_rx_bad_packet Choices: `false` `true`
if_state_change boolean	if_state_change Choices: `false` `true`
nbr_restart_helper_status_change boolean	Включить ловушку ospfv3NbrRestartHelperStatusChange Choices: `false` `true`
nbr_state_change boolean	nbr_state_change. Choices: `false` `true`
nssa_translator_status_change boolean	Включить ловушку ospfv3NssaTranslatorStatusChange Choices: `false` `true`
restart_status_change boolean	restart_status_change Choices: `false` `true`

pim dictionary	Включить PIM-ловушки. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
neighbor_loss boolean	neighbor_loss Choices: `false` `true`
snmp dictionary	Включить SNMP-ловушки. Если установлено значение enabled, устанавливаются все ловушки.
authentication boolean	authentication Choices: `false` `true`
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
link_down boolean	link_down Choices: `false` `true`
link_up boolean	link_up Choices: `false` `true`
snmpConfigManEvent dictionary	Включить snmpConfigManEvent ловушки. Если установлено значение enabled, устанавливаются все ловушки.
arista_config_man_event boolean	arista_config_man_event Choices: `false` `true`
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
switchover dictionary	Включить ловушки переключения. Если установлено значение enabled, устанавливаются все ловушки.
arista_redundancy_switch_over_notif boolean	arista_redundancy_switch_over_notif Choices: `false` `true`
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
test dictionary	Включить тестовые ловушки. Если установлено значение enabled, устанавливаются все ловушки.
arista_test_notification boolean	arista_test_notification Choices: `false` `true`
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
vrrp dictionary	Включить VRRP-ловушки. Если установлено значение enabled, устанавливаются все ловушки.
enabled boolean	Устанавливаются все ловушки. Choices: `false` `true`
trap_new_master boolean	vrrp Choices: `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	Engine id
priv_passphrase string	фраза-пароль приватности в шестнадцатеричном формате
remote string	Система, на которой размещен пользователь SNMPv3
udp_port integer	UDP-порт, используемый удаленной системой SNMP
user string	Имя пользователя SNMP
version string	версия безопасности snmp Варианты: `"v1"` `"v2c"` `"v3"`
views list / elements=dictionary	Конфигурация представления SNMPv2 MIB
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 в соответствии со спецификацией argspec модуля ресурса, а затем возвращаемое значение находится в ключе 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 словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда состояние равно `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands список / элементы=строка	Набор команд, переданных удаленному устройству. Возвращается: когда состояние равно `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 список / элементы=строка	Данные о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда состояние равно `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed список / элементы=строка	Родная конфигурация устройства из параметра running_config, разобранная в структурированные данные в соответствии с argspec модуля. Возвращается: когда состояние равно `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered список / элементы=строка	Предоставленная конфигурация в задаче, отрендеренная в формате, понятном устройству (офлайн). Возвращается: когда состояние равно `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/arista/eos/eos_snmp_server_module.html