Модуль cisco.nxos.nxos_snmp_server — модуль ресурсов SNMP-сервера.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.nxos.nxos_snmp_server.

Добавлено в cisco.nxos 2.8.0

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

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

Этот модуль управляет конфигурацией SNMP-сервера на устройствах под управлением Cisco NX-OS.

Примечание

Для этого модуля предусмотрен соответствующий плагин действий.

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

Параметры

Параметр	Комментарии
config dictionary	Словарь конфигурации SNMP-сервера
aaa_user dictionary	Задает срок существования кэшированного пользователя AAA для SNMP.
cache_timeout integer	Тайм-аут существования кэшированного пользователя AAA (в секундах).
communities list / elements=dictionary	Задает строку сообщества и права доступа.
group string	Группа, к которой относится сообщество.
name псевдонимы: community string	Строка сообщества SNMP (макс. размер — 32).
ro boolean	Доступ только для чтения с этой строкой сообщества. Возможные значения: `false` `true`
rw boolean	Доступ для чтения и записи с этой строкой сообщества. Возможные значения: `false` `true`
use_ipv4acl string	Указывает ACL IPv4; указанное имя ACL должно соответствовать ACL IPv4. Этот параметр не поддерживается на коммутаторах MDS.
use_ipv6acl string	Указывает ACL IPv6; указанное имя ACL должно соответствовать ACL IPv6. Этот параметр не поддерживается на коммутаторах MDS.
contact string	Изменяет sysContact.
context dictionary	Контекст SNMP для сопоставления.
instance string	Имя экземпляра протокола (макс. размер — 32).
name string	Имя контекста SNMP (макс. размер — 32).
topology string	Топология, связанная с контекстом SNMP.
vrf string	VRF, связанная с контекстом SNMP. Этот параметр не поддерживается на коммутаторах MDS.
counter dictionary	Настройка счетчиков портов. Этот параметр не поддерживается на коммутаторах MDS.
cache dictionary	Кэш статистики портов.
enable boolean	Включает кэш статистики портов. Возможные значения: `false` `true`
timeout integer	Тайм-аут существования кэшированной статистики портов (в секундах).
drop dictionary	Без уведомления отбрасывает пакеты неизвестных пользователей v3. Этот параметр не поддерживается на коммутаторах MDS.
unknown_engine_id boolean	Неизвестный идентификатор движка v3. Возможные значения: `false` `true`
unknown_user boolean	Неизвестный пользователь v3. Возможные значения: `false` `true`
engine_id dictionary	Настройка локального engineID SNMPv3. Этот параметр не поддерживается на коммутаторах MDS.
local string	EngineID локального агента.
global_enforce_priv boolean	Принудительно включает конфиденциальность для всех пользователей глобально. Возможные значения: `false` `true`
hosts list / elements=dictionary	Указывает хосты для получения уведомлений SNMP. Строки конфигурации хостов SNMP, которые отображаются отдельно в running-config, необходимо добавлять как отдельные словари.
auth string	Использует уровень безопасности SNMPv3 authNoPriv.
community string	Строка сообщества SNMP или имя пользователя SNMPv3 (макс. размер — 32).
filter_vrf string	Фильтрует уведомления для получателя на хосте уведомлений на основе настроенной VRF. Этот параметр не поддерживается на коммутаторах MDS.
host string	Адрес IPv4 или IPv6 либо DNS-имя хоста, получающего уведомления SNMP.
informs boolean	Отправляет этому хосту сообщения Inform. Возможные значения: `false` `true`
priv string	Использует уровень безопасности SNMPv3 authPriv.
source_interface string	Исходный интерфейс для отправки уведомлений SNMP этому хосту.
traps boolean	Отправляет этому хосту сообщения Trap. Возможные значения: `false` `true`
udp_port integer	Номер UDP-порта хоста уведомлений.
use_vrf string	Настраивает SNMP на использование выбранной VRF для связи с получателем на хосте. Этот параметр не поддерживается на коммутаторах MDS.
version string	Версия SNMP для сообщений уведомлений. Возможные значения: `"1"` `"2c"` `"3"`
location string	Изменяет sysLocation.
mib dictionary	Параметры доступа к MIB.
community_map dictionary	Сообщество SNMP.
community string	Строка сообщества SNMP (макс. размер — 32).
context string	Имя контекста SNMP (макс. размер — 32).
packetsize integer	Максимальный размер пакета SNMP
protocol dictionary	Операции протокола SNMP.
enable boolean	Включает или отключает операции протокола SNMP. Возможные значения: `false` `true`
source_interface dictionary	Исходный интерфейс для отправки уведомлений SNMP. Этот параметр не поддерживается на коммутаторах MDS.
informs string	Уведомления SNMP Inform, для которых следует использовать этот исходный интерфейс.
traps string	Уведомления SNMP Trap, для которых следует использовать этот исходный интерфейс.
system_shutdown boolean	Настраивает snmp-server для перезагрузки (2). Возможные значения: `false` `true`
tcp_session dictionary	Включает одноразовую аутентификацию SNMP через сеанс TCP.
auth boolean	Включает одноразовую аутентификацию SNMP через сеанс TCP. Возможные значения: `false` `true`
enable boolean	Включает сеанс TCP. Этот параметр не поддерживается на коммутаторах MDS. Возможные значения: `false` `true`
traps dictionary	Включает SNMP Traps
aaa dictionary	Ловушки AAA
enable boolean	Включает ловушки AAA. Возможные значения: `false` `true`
server_state_change boolean	Уведомление об изменении состояния сервера AAA. Возможные значения: `false` `true`
bgp dictionary	Ловушки BGP SNMP.
enable boolean	Включает ловушки BGP SNMP. Возможные значения: `false` `true`
bridge dictionary	Ловушки моста. Этот параметр не поддерживается на коммутаторах MDS.
enable boolean	Включает ловушки моста. Возможные значения: `false` `true`
newroot boolean	Включает ловушки newroot для MIB моста STP SNMP. Возможные значения: `false` `true`
topologychange boolean	Включает ловушки topologychange для MIB моста STP SNMP. Возможные значения: `false` `true`
callhome dictionary	Ловушки Callhome.
enable boolean	Включает ловушки Callhome. Этот параметр не поддерживается на коммутаторах MDS. Возможные значения: `false` `true`

event_notify boolean	Уведомление о внешнем событии Callhome. Варианты: `false` `true`
smtp_send_fail boolean	Уведомление о сбое отправки сообщения SMTP. Варианты: `false` `true`
cfs dictionary	Трапы CFS.
enable boolean	Включить трапы CFS. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
merge_failure boolean	Уведомление о сбое слияния. Варианты: `false` `true`
state_change_notif boolean	Уведомление об изменении состояния. Варианты: `false` `true`
config dictionary	Трапы конфигурации.
ccmCLIRunningConfigChanged boolean	Трап об изменении текущей конфигурации. Варианты: `false` `true`
enable boolean	Включить трапы конфигурации. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
entity dictionary	Трапы сущностей.
cefcMIBEnableStatusNotification boolean	cefcMIBEnableStatusNotification. Варианты: `false` `true`
enable boolean	Включить трапы сущностей. Варианты: `false` `true`
entity_fan_status_change boolean	Изменение состояния вентилятора сущности. Варианты: `false` `true`
entity_mib_change boolean	Изменение MIB сущности. Варианты: `false` `true`
entity_module_inserted boolean	Модуль сущности установлен. Варианты: `false` `true`
entity_module_removed boolean	Модуль сущности извлечён. Варианты: `false` `true`
entity_module_status_change boolean	Изменение состояния модуля сущности. Варианты: `false` `true`
entity_power_out_change boolean	Изменение выходной мощности сущности. Варианты: `false` `true`
entity_power_status_change boolean	Изменение состояния питания сущности. Варианты: `false` `true`
entity_sensor boolean	Датчик сущности. Варианты: `false` `true`
entity_unrecognised_module boolean	Неопознанный модуль сущности. Варианты: `false` `true`
feature_control dictionary	Трапы управления функциями.
ciscoFeatOpStatusChange boolean	Уведомление об изменении рабочего состояния функции. Варианты: `false` `true`
enable boolean	Включить трапы управления функциями. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
featureOpStatusChange boolean	Уведомление об изменении рабочего состояния функции. Варианты: `false` `true`
generic dictionary	Общие трапы.
coldStart boolean	Общий трап coldStart. Варианты: `false` `true`
enable boolean	Включить общие трапы. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
warmStart boolean	Общий трап warmStart. Варианты: `false` `true`
license dictionary	Трапы лицензий.
enable boolean	Включить трапы лицензий. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
notify_license_expiry boolean	Уведомление об истечении срока действия лицензии. Варианты: `false` `true`
notify_license_expiry_warning boolean	Уведомление-предупреждение об истечении срока действия лицензии. Варианты: `false` `true`
notify_licensefile_missing boolean	Уведомление об отсутствии файла лицензии. Варианты: `false` `true`
notify_no_license_for_feature boolean	Уведомление об отсутствии установленной лицензии для функции. Варианты: `false` `true`
link dictionary	Трапы каналов связи.
cErrDisableInterfaceEventRev1 boolean	Уведомление о состоянии err-disable. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
cieLinkDown boolean	Расширенное уведомление Cisco о состоянии канала связи «неактивен». Варианты: `false` `true`
cieLinkUp boolean	Расширенное уведомление Cisco о состоянии канала связи «активен». Варианты: `false` `true`
cisco_xcvr_mon_status_chg boolean	Уведомление Cisco об изменении состояния мониторинга трансивера интерфейса. Варианты: `false` `true`
cmn_mac_move_notification boolean	Трап о перемещении MAC-адреса. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
delayed_link_state_change boolean	Отложенное изменение состояния канала связи. Варианты: `false` `true`
enable boolean	Включить трапы каналов связи. Этот параметр не поддерживается на коммутаторах MDS. Варианты: `false` `true`
extended_linkDown boolean	Расширенное уведомление IETF о состоянии канала связи «неактивен». Варианты: `false` `true`
extended_linkUp boolean	Расширенное уведомление IETF о состоянии канала связи «активен». Варианты: `false` `true`
linkDown boolean	Уведомление IETF о состоянии канала связи «неактивен». Варианты: `false` `true`
linkUp boolean	Уведомление IETF о состоянии канала связи «активен». Варианты: `false` `true`
mmode dictionary	Трапы MMode. Этот параметр не поддерживается на коммутаторах MDS.
cseMaintModeChangeNotify boolean	Уведомление об изменении режима обслуживания. Варианты: `false` `true`
cseNormalModeChangeNotify boolean	Уведомление об изменении обычного режима. Варианты: `false` `true`
enable boolean	Включить трапы mmode. Варианты: `false` `true`
ospf dictionary	Трапы SNMP OSPF.
enable boolean	Включить трапы SNMP OSPF. Варианты: `false` `true`
ospfv3 dictionary	Трапы SNMP OSPFv3.
enable boolean	Включить трапы SNMP OSPFv3. Варианты: `false` `true`

rf dictionary	Трапы RF.
enable boolean	Включить трапы RF. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
redundancy_framework boolean	MIB переключения супервизора Redundancy Framework (RF). Варианты: `false` `true`
rmon dictionary	Трапы RMON.
enable boolean	Включить трапы RMON. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
fallingAlarm boolean	Сигнализация о снижении значения RMON. Варианты: `false` `true`
hcFallingAlarm boolean	Сигнализация о снижении значения RMON высокой емкости. Варианты: `false` `true`
hcRisingAlarm boolean	Сигнализация о повышении значения RMON высокой емкости. Варианты: `false` `true`
risingAlarm boolean	Сигнализация о повышении значения RMON. Варианты: `false` `true`
snmp dictionary	Трапы SNMP.
authentication boolean	Трап аутентификации SNMP. Варианты: `false` `true`
enable boolean	Включить трапы SNMP. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
storm_control dictionary	Трапы Storm-Control.
cpscEventRev1 boolean	Событие управления штормом на порту. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
enable boolean	Включить трапы storm-control. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
trap_rate boolean	Количество трапов в минуту. Варианты: `false` `true`
stpx dictionary	Трапы STPX. Этот параметр не поддерживается коммутаторами MDS.
enable boolean	Включить трапы STPX. Варианты: `false` `true`
inconsistency boolean	Включить трапы SNMP STPX MIB InconsistencyUpdate. Варианты: `false` `true`
loop_inconsistency boolean	Включить трапы SNMP STPX MIB LoopInconsistencyUpdate. Варианты: `false` `true`
root_inconsistency boolean	Включить трапы SNMP STPX MIB RootInconsistencyUpdate. Варианты: `false` `true`
syslog dictionary	Включить трапы syslog.
enable boolean	Включить трапы syslog. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
message_generated boolean	Уведомление о созданном сообщении. Варианты: `false` `true`
sysmgr dictionary	Трапы Sysmgr.
cseFailSwCoreNotifyExtended boolean	Уведомление о сбое программного ядра. Варианты: `false` `true`
enable boolean	Включить трапы sysmgr. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
system dictionary	Системные трапы.
clock_change_notification boolean	Трапы уведомления об изменении часов. Варианты: `false` `true`
enable boolean	Включить системные трапы. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
upgrade dictionary	Трапы обновления.
enable boolean	Включить трапы обновления. Этот параметр не поддерживается коммутаторами MDS. Варианты: `false` `true`
upgradeJobStatusNotify boolean	Уведомление о состоянии задания обновления. Варианты: `false` `true`
upgradeOpNotifyOnCompletion boolean	Уведомление об общем состоянии обновления. Варианты: `false` `true`
vtp dictionary	Трапы VTP. Этот параметр не поддерживается коммутаторами MDS.
enable boolean	Включить трапы VTP. Варианты: `false` `true`
notifs boolean	Включить уведомления vtpConfigRevNumberError, vtpConfigDigestEnable, vtpConfigRevNumberError, vtpConfigDigestError, vtpServerDisabled, vtpVersionOneDeviceDetected, vlanTrunkPortDynamicStatusChange, vtpLocalModeChanged и vtpVersionInUseChanged. Варианты: `false` `true`
vlancreate boolean	Включить уведомление vtpVlanCreated. Варианты: `false` `true`
vlandelete boolean	Включить уведомление vtpVlanDeleted. Варианты: `false` `true`
users dictionary	Определить пользователей, которым разрешен доступ к механизму SNMP.
auth list / elements=dictionary	Настройки аутентификации пользователя SNMP
authentication dictionary	Параметры аутентификации пользователя.
algorithm string	Выбрать алгоритм аутентификации. Варианты: `"md5"` `"sha"` `"sha-256"`
engine_id string	EngineID для настройки пользователя-адресата уведомлений (для информ-запросов V3). Это значение необходимо заключить в кавычки в задании.
localized_key boolean	Указывает, хранятся ли пароли в формате локализованного ключа. Варианты: `false` `true`
localizedv2_key boolean	Указывает, хранятся ли пароли в формате локализованного ключа V2. Варианты: `false` `true`
password string	Пароль аутентификации пользователя (максимальный размер — 127 символов). Если это значение локализовано, его необходимо заключить в кавычки в задании.
priv dictionary	Параметры шифрования пользователя.
aes_128 boolean	Использовать для обеспечения конфиденциальности алгоритм AES с ключом длиной 128 бит. Варианты: `false` `true`
privacy_password string	Пароль конфиденциальности пользователя (максимальный размер — 130 символов). Если это значение локализовано, его необходимо заключить в кавычки в задании.
group string	Имя группы (игнорируется для пользователя-адресата уведомлений) (максимальный размер — 28 символов).
user string	Имя пользователя (максимальный размер — 28 символов).
use_acls list / elements=dictionary	Задать используемые списки контроля доступа IPv4 и IPv6.
ipv4 string	Указать список контроля доступа IPv4; указанное далее имя списка должно относиться к списку контроля доступа IPv4.
ipv6 string	Указать список контроля доступа IPv6; указанное далее имя списка должно относиться к списку контроля доступа IPv6.
user string	Имя пользователя (максимальный размер — 28 символов).
running_config string	Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config \| section ‘^snmp-server’. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible согласно спецификации аргументов модуля ресурса, после чего возвращает значение в ключе parsed результата.

state

string

Состояние, в котором должна остаться конфигурация.

Состояния replaced и overridden работают в этом модуле одинаково.

Дополнительные сведения см. в примерах.

Варианты:

"merged" ← (по умолчанию)
"replaced"
"overridden"
"deleted"
"parsed"
"gathered"
"rendered"

Примечания

Примечание

Проверено на коммутаторах Cisco Nexus с NX-OS 9.3.6.
Этот модуль работает с подключениями network_cli и httpapi.
Проверено на Cisco MDS с NX-OS 9.2(2) и подключением network_cli.

Примеры

# Using merged

# Before state:
# -------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey

- name: Merge the provided configuration with the existing running configuration
  cisco.nxos.nxos_snmp_server:
    config:
      aaa_user:
        cache_timeout: 36000
      communities:
        - community: public
          group: network-operator
        - community: private
          group: network-admin
      contact: nxosswitchadmin@localhost
      location: serverroom-1
      traps:
        aaa:
          server_state_change: true
        system:
          clock_change_notification: true
      hosts:
        - host: 192.0.2.1
          traps: true
          version: '1'
          community: public
        - host: 192.0.2.1
          source_interface: Ethernet1/1
        - host: 192.0.2.2
          informs: true
          version: '3'
          auth: NMS
      users:
        auth:
          - user: snmp_user_1
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true
          - user: snmp_user_2
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true
              priv:
                privacy_password: '0x5632724fb8ac3699296af26281e1d0f1'
                aes_128: true
        use_acls:
          - user: snmp_user_1
            ipv4: acl1
            ipv6: acl2
          - user: snmp_user_2
            ipv4: acl3
            ipv6: acl4

# Task output
# -------------
# before:
#   users:
#     auth:
#       - user: admin
#         group: network-admin
#         authentication:
#           algorithm: md5
#           password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#           localized_key: true
#           priv:
#             privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#
# commands:
#   - snmp-server contact nxosswitchadmin@localhost
#   - snmp-server location serverroom-1
#   - snmp-server aaa-user cache-timeout 36000
#   - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#   - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#   - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
#   - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
#   - snmp-server host 192.0.2.1 traps version 1 public
#   - snmp-server host 192.0.2.1 source-interface Ethernet1/1
#   - snmp-server host 192.0.2.2 informs version 3 auth NMS
#   - snmp-server community private group network-admin
#   - snmp-server community public group network-operator
#   - snmp-server enable traps aaa server-state-change
#   - snmp-server enable traps system Clock-change-notification
#
# after:
#   aaa_user:
#      cache_timeout: 36000
#    communities:
#      - community: private
#        group: network-admin
#      - community: public
#        group: network-operator
#    contact: nxosswitchadmin@localhost
#    location: serverroom-1
#    traps:
#      aaa:
#        server_state_change: true
#      system:
#        clock_change_notification: true
#    hosts:
#      - host: 192.0.2.1
#        traps: true
#        version: "1"
#        community: public
#
#      - host: 192.0.2.1
#        source_interface: Ethernet1/1
#
#      - host: 192.0.2.2
#        informs: true
#        version: "3"
#        auth: NMS
#    users:
#      auth:
#        - user: admin
#          group: network-admin
#          authentication:
#            algorithm: md5
#            password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#            localized_key: true
#            priv:
#              privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#
#        - user: snmp_user_1
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            localized_key: true
#
#        - authentication:
#            algorithm: md5
#            localized_key: true
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            priv:
#              aes_128: true
#              privacy_password: "0x5632724fb8ac3699296af26281e1d0f1"
#          group: network-operator
#          user: snmp_user_2
#
#      use_acls:
#        - user: snmp_user_1
#          ipv4: acl1
#          ipv6: acl2
#        - user: snmp_user_2
#          ipv4: acl3
#          ipv6: acl4

# After state:
# ------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server contact nxosswitchadmin@localhost
# snmp-server location serverroom-1
# snmp-server aaa-user cache-timeout 36000
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey
# snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
# snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
# snmp-server host 192.0.2.1 traps version 1 public
# snmp-server host 192.0.2.1 source-interface Ethernet1/1
# snmp-server host 192.0.2.2 informs version 3 auth NMS
# snmp-server community private group network-admin
# snmp-server community public group network-operator
# snmp-server enable traps aaa server-state-change
# snmp-server enable traps system Clock-change-notification

# Using replaced

# Before state:
# ------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server contact nxosswitchadmin@localhost
# snmp-server location serverroom-1
# snmp-server aaa-user cache-timeout 36000
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey
# snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
# snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
# snmp-server host 192.0.2.1 traps version 1 public
# snmp-server host 192.0.2.1 source-interface Ethernet1/1
# snmp-server host 192.0.2.2 informs version 3 auth NMS
# snmp-server community private group network-admin
# snmp-server community public group network-operator
# snmp-server enable traps aaa server-state-change
# snmp-server enable traps system Clock-change-notification

- name: Replace snmp-server configurations of listed snmp-server with provided configurations
  cisco.nxos.nxos_snmp_server:
    config:
      aaa_user:
        cache_timeout: 36000
      communities:
        - community: public
          group: network-operator
        - community: secret
          group: network-operator
      contact: nxosswitchadmin2@localhost
      location: serverroom-2
      traps:
        aaa:
          server_state_change: true
      hosts:
        - host: 192.0.2.1
          traps: true
          version: '1'
          community: public
        - host: 192.0.2.1
          source_interface: Ethernet1/1
        - host: 192.0.3.2
          informs: true
          version: '3'
          auth: NMS
      users:
        auth:
          - user: admin
            group: network-admin
            authentication:
              algorithm: md5
              password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
              localized_key: true
              priv:
                privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"

          - user: snmp_user_1
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true

          - user: snmp_user_2
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true
              priv:
                privacy_password: '0x5632724fb8ac3699296af26281e1d0f1'
                aes_128: true
        use_acls:
          - user: snmp_user_1
            ipv4: acl1
            ipv6: acl2
    state: replaced

# Task output
# -------------
# before:
#   aaa_user:
#      cache_timeout: 36000
#    communities:
#      - community: private
#        group: network-admin
#      - community: public
#        group: network-operator
#    contact: nxosswitchadmin@localhost
#    location: serverroom-1
#    traps:
#      aaa:
#        server_state_change: true
#      system:
#        clock_change_notification: true
#    hosts:
#      - host: 192.0.2.1
#        traps: true
#        version: "1"
#        community: public
#
#      - host: 192.0.2.1
#        source_interface: Ethernet1/1
#
#      - host: 192.0.2.2
#        informs: true
#        version: "3"
#        auth: NMS
#    users:
#      auth:
#        - user: admin
#          group: network-admin
#          authentication:
#            algorithm: md5
#            password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#            localized_key: true
#            priv:
#              privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#
#        - user: snmp_user_1
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            localized_key: true
#
#        - authentication:
#            algorithm: md5
#            localized_key: true
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            priv:
#              aes_128: true
#              privacy_password: "0x5632724fb8ac3699296af26281e1d0f1"
#          group: network-operator
#          user: snmp_user_2
#
#      use_acls:
#        - user: snmp_user_1
#          ipv4: acl1
#          ipv6: acl2
#        - user: snmp_user_2
#          ipv4: acl3
#          ipv6: acl4
#
# commands:
#   - snmp-server contact nxosswitchadmin2@localhost
#   - no snmp-server enable traps system Clock-change-notification
#   - snmp-server location serverroom-2
#   - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
#   - no snmp-server host 192.0.2.2 informs version 3 auth NMS
#   - snmp-server host 192.0.3.2 informs version 3 auth NMS
#   - no snmp-server community private group network-admin
#   - snmp-server community secret group network-operator
#
# after:
#   aaa_user:
#      cache_timeout: 36000
#    communities:
#      - community: public
#        group: network-operator
#      - community: secret
#        group: network-operator
#    contact: nxosswitchadmin2@localhost
#    location: serverroom-2
#    traps:
#      aaa:
#        server_state_change: true
#    hosts:
#      - host: 192.0.2.1
#        traps: true
#        version: '1'
#        community: public
#      - host: 192.0.2.1
#        source_interface: Ethernet1/1
#      - host: 192.0.3.2
#        informs: true
#        version: '3'
#        auth: NMS
#    users:
#      auth:
#        - user: admin
#          group: network-admin
#          authentication:
#            algorithm: md5
#            password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#            localized_key: true
#            priv:
#              privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#
#        - user: snmp_user_1
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: '0x5632724fb8ac3699296af26281e1d0f1'
#            localized_key: true
#
#        - user: snmp_user_2
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: '0x5632724fb8ac3699296af26281e1d0f1'
#            localized_key: true
#            priv:
#              privacy_password: '0x5632724fb8ac3699296af26281e1d0f1'
#              aes_128: true
#
#      use_acls:
#        - user: snmp_user_1
#          ipv4: acl1
#          ipv6: acl2
#

# After state:
# ------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server contact nxosswitchadmin2@localhost
# snmp-server location serverroom-2
# snmp-server aaa-user cache-timeout 36000
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey
# snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
# snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
# snmp-server host 192.0.2.1 traps version 1 public
# snmp-server host 192.0.2.1 source-interface Ethernet1/1
# snmp-server host 192.0.2.2 informs version 3 auth NMS
# snmp-server community secret group network-operator
# snmp-server community public group network-operator
# snmp-server enable traps aaa server-state-change
# snmp-server enable traps system Clock-change-notification

# Using deleted

# Before state:
# ------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server contact nxosswitchadmin@localhost
# snmp-server location serverroom-1
# snmp-server aaa-user cache-timeout 36000
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey
# snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
# snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
# snmp-server host 192.0.2.1 traps version 1 public
# snmp-server host 192.0.2.1 source-interface Ethernet1/1
# snmp-server host 192.0.2.2 informs version 3 auth NMS
# snmp-server community private group network-admin
# snmp-server community public group network-operator
# snmp-server enable traps aaa server-state-change
# snmp-server enable traps system Clock-change-notification

- name: Delete SNMP Server configurations from the device (admin user will not be deleted)
  cisco.nxos.nxos_snmp_server:
    state: deleted

# Task output
# -------------
# before:
#   aaa_user:
#      cache_timeout: 36000
#    communities:
#      - community: private
#        group: network-admin
#      - community: public
#        group: network-operator
#    contact: nxosswitchadmin@localhost
#    location: serverroom-1
#    traps:
#      aaa:
#        server_state_change: true
#      system:
#        clock_change_notification: true
#    hosts:
#      - host: 192.0.2.1
#        traps: true
#        version: "1"
#        community: public
#
#      - host: 192.0.2.1
#        source_interface: Ethernet1/1
#
#      - host: 192.0.2.2
#        informs: true
#        version: "3"
#        auth: NMS
#    users:
#      auth:
#        - user: admin
#          group: network-admin
#          authentication:
#            algorithm: md5
#            password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#            localized_key: true
#            priv:
#              privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#
#        - user: snmp_user_1
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            localized_key: true
#
#        - authentication:
#            algorithm: md5
#            localized_key: true
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            priv:
#              aes_128: true
#              privacy_password: "0x5632724fb8ac3699296af26281e1d0f1"
#          group: network-operator
#          user: snmp_user_2
#
#      use_acls:
#        - user: snmp_user_1
#          ipv4: acl1
#          ipv6: acl2
#        - user: snmp_user_2
#          ipv4: acl3
#          ipv6: acl4
#
# commands:
#   - no snmp-server contact nxosswitchadmin@localhost
#   - no snmp-server location serverroom-1
#   - no snmp-server aaa-user cache-timeout 36000
#   - no snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey
#   - no snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#   - no snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#   - no snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
#   - no snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
#   - no snmp-server host 192.0.2.1 traps version 1 public
#   - no snmp-server host 192.0.2.1 source-interface Ethernet1/1
#   - no snmp-server host 192.0.2.2 informs version 3 auth NMS
#   - no snmp-server community private group network-admin
#   - no snmp-server community public group network-operator
#   - no snmp-server enable traps aaa server-state-change
#   - no snmp-server enable traps system Clock-change-notification
#
# after:
#   users:
#     auth:
#       - user: admin
#         group: network-admin
#         authentication:
#           algorithm: md5
#           password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"
#           localized_key: true
#           priv:
#             privacy_password: "0xcbde46b02c46e0bcd3ac5af6a8b13da9"

# After state:
# ------------
# nxos-9k-rdo# show running-config | section "^snmp-server"
# snmp-server user admin network-admin auth md5 0xcbde46b02c46e0bcd3ac5af6a8b13da9 priv 0xcbde46b02c46e0bcd3ac5af6a8b13da9 localizedkey

# Using rendered
# ---------------

- name: Render platform specific configuration lines with state rendered (without connecting to the device)
  cisco.nxos.nxos_snmp_server:
    config:
      aaa_user:
        cache_timeout: 36000
      communities:
        - community: public
          group: network-operator
        - community: private
          group: network-admin
      contact: nxosswitchadmin@localhost
      location: serverroom-1
      traps:
        aaa:
          server_state_change: true
        system:
          clock_change_notification: true
      hosts:
        - host: 192.0.2.1
          traps: true
          version: '1'
          community: public
        - host: 192.0.2.1
          source_interface: Ethernet1/1
        - host: 192.0.2.2
          informs: true
          version: '3'
          auth: NMS
      users:
        auth:
          - user: snmp_user_1
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true
          - user: snmp_user_2
            group: network-operator
            authentication:
              algorithm: md5
              password: '0x5632724fb8ac3699296af26281e1d0f1'
              localized_key: true
              priv:
                privacy_password: '0x5632724fb8ac3699296af26281e1d0f1'
                aes_128: true
        use_acls:
          - user: snmp_user_1
            ipv4: acl1
            ipv6: acl2
          - user: snmp_user_2
            ipv4: acl3
            ipv6: acl4
    state: rendered


# Task Output (redacted)
# -----------------------
#  rendered:
#    - snmp-server contact nxosswitchadmin@localhost
#    - snmp-server location serverroom-1
#    - snmp-server aaa-user cache-timeout 36000
#    - snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#    - snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
#    - snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
#    - snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
#    - snmp-server host 192.0.2.1 traps version 1 public
#    - snmp-server host 192.0.2.1 source-interface Ethernet1/1
#    - snmp-server host 192.0.2.2 informs version 3 auth NMS
#    - snmp-server community private group network-admin
#    - snmp-server community public group network-operator
#    - snmp-server enable traps aaa server-state-change
#    - snmp-server enable traps system Clock-change-notification

# Using parsed

# parsed.cfg
# ------------
# snmp-server contact nxosswitchadmin@localhost
# snmp-server location serverroom-1
# snmp-server aaa-user cache-timeout 36000
# snmp-server user snmp_user_1 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_2 network-operator auth md5 0x5632724fb8ac3699296af26281e1d0f1 priv aes-128 0x5632724fb8ac3699296af26281e1d0f1 localizedkey
# snmp-server user snmp_user_1 use-ipv4acl acl1 use-ipv6acl acl2
# snmp-server user snmp_user_2 use-ipv4acl acl3 use-ipv6acl acl4
# snmp-server host 192.0.2.1 traps version 1 public
# snmp-server host 192.0.2.1 source-interface Ethernet1/1
# snmp-server host 192.0.2.2 informs version 3 auth NMS
# snmp-server community private group network-admin
# snmp-server community public group network-operator
# snmp-server enable traps aaa server-state-change
# snmp-server enable traps system Clock-change-notification

- name: Parse externally provided snmp-server configuration
  cisco.nxos.nxos_snmp_server:
    running_config: "{{ lookup('file', './parsed.cfg') }}"
    state: parsed

# Task output (redacted)
# -----------------------
#  parsed:
#   aaa_user:
#      cache_timeout: 36000
#    communities:
#      - community: private
#        group: network-admin
#      - community: public
#        group: network-operator
#    contact: nxosswitchadmin@localhost
#    location: serverroom-1
#    traps:
#      aaa:
#        server_state_change: true
#      system:
#        clock_change_notification: true
#    hosts:
#      - host: 192.0.2.1
#        traps: true
#        version: "1"
#        community: public
#
#      - host: 192.0.2.1
#        source_interface: Ethernet1/1
#
#      - host: 192.0.2.2
#        informs: true
#        version: "3"
#        auth: NMS
#    users:
#      auth:
#        - user: snmp_user_1
#          group: network-operator
#          authentication:
#            algorithm: md5
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            localized_key: true
#
#        - authentication:
#            algorithm: md5
#            localized_key: true
#            password: "0x5632724fb8ac3699296af26281e1d0f1"
#            priv:
#              aes_128: true
#              privacy_password: "0x5632724fb8ac3699296af26281e1d0f1"
#          group: network-operator
#          user: snmp_user_2
#
#      use_acls:
#        - user: snmp_user_1
#          ipv4: acl1
#          ipv6: acl2
#        - user: snmp_user_2
#          ipv4: acl3
#          ipv6: acl4
#

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

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

Ключ	Описание
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` Пример: `["sample command 1", "sample command 2", "sample command 3"]`
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` Пример: `["sample command 1", "sample command 2", "sample command 3"]`

Авторы

Nilashish Chakraborty (@NilashishC)

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

© 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/cisco/nxos/nxos_snmp_server_module.html