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

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.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	Установить продолжительность существования пользователя snmp с кэшем aaa.
cache_timeout integer	Время ожидания существования пользователя с кэшем aaa (в секундах).
communities list / elements=dictionary	Установить строку сообщества и привилегии доступа.
group string	Группа, к которой принадлежит сообщество.
name aliases: 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	Глобально обеспечить конфиденциальность для всех пользователей. Choices: `false` `true`
hosts list / elements=dictionary	Укажите узлы, которые будут получать уведомления SNMP. Строки конфигурации узлов SNMP, которые отображаются отдельно в работающей конфигурации, должны быть добавлены в качестве отдельных словарей.
auth string	Использовать уровень безопасности SNMPv3 authNoPriv.
community string	Строка сообщества SNMP или имя пользователя SNMPv3 (максимальный размер 32).
filter_vrf string	Фильтры уведомлений для узла-приемника уведомлений на основе настроенного VRF. Эта опция не поддерживается на коммутаторах MDS.
host string	IPv4 или IPv6 адрес или DNS имя узла уведомления SNMP.
informs boolean	Отправить сообщения Inform этому узлу. Choices: `false` `true`
priv string	Использовать уровень безопасности SNMPv3 authPriv.
source_interface string	Исходный интерфейс, который будет использоваться для отправки уведомлений SNMP этому узлу.
traps boolean	Отправить сообщения Traps этому узлу. Choices: `false` `true`
udp_port integer	Номер порта UDP узла уведомлений.
use_vrf string	Настраивает SNMP для использования выбранного VRF для связи с узлом-приемником. Эта опция не поддерживается на коммутаторах MDS.
version string	Версия SNMP, используемая для сообщений уведомлений. Choices: `"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. Choices: `false` `true`
source_interface dictionary	Исходный интерфейс, который будет использоваться для отправки уведомлений SNMP. Эта опция не поддерживается на коммутаторах MDS.
informs string	Уведомления SNMP Inform, для которых необходимо использовать этот исходный интерфейс.
traps string	Уведомления SNMP Trap, для которых необходимо использовать этот исходный интерфейс.

system_shutdown boolean	Настроить snmp-server для перезагрузки(2). Choices: `false` `true`
tcp_session dictionary	Включить однократную аутентификацию для snmp через tcp-сеанс.
auth boolean	Включить однократную аутентификацию для snmp через tcp-сеанс. Choices: `false` `true`
enable boolean	Включить tcp-сеанс. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
traps dictionary	Включить SNMP Traps
aaa dictionary	AAA traps
enable boolean	Включить AAA traps. Choices: `false` `true`
server_state_change boolean	Уведомление об изменении состояния сервера AAA. Choices: `false` `true`
bgp dictionary	SNMP BGP traps.
enable boolean	Включить SNMP BGP traps. Choices: `false` `true`
bridge dictionary	Bridge traps. Эта опция не поддерживается на коммутаторах MDS.
enable boolean	Включить bridge traps. Choices: `false` `true`
newroot boolean	Включить SNMP STP Bridge MIB newroot traps. Choices: `false` `true`
topologychange boolean	Включить SNMP STP Bridge MIB topologychange traps. Choices: `false` `true`
callhome dictionary	Callhome traps.
enable boolean	Включить callhome traps. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
event_notify boolean	Внешнее уведомление о событиях Callhome. Choices: `false` `true`
smtp_send_fail boolean	Уведомление об ошибке отправки сообщения SMTP. Choices: `false` `true`
cfs dictionary	CFS traps.
enable boolean	Включить cfs traps. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
merge_failure boolean	Уведомление об ошибке слияния. Choices: `false` `true`

state_change_notif boolean	Уведомление об изменении состояния. Choices: `false` `true`
config dictionary	Ловушки конфигурации.
ccmCLIRunningConfigChanged boolean	Ловушка изменения запущенной конфигурации. Choices: `false` `true`
enable boolean	Включить ловушки конфигурации. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
entity dictionary	Ловушки сущностей.
cefcMIBEnableStatusNotification boolean	CefcMIBEnableStatusNotification. Choices: `false` `true`
enable boolean	Включить ловушки сущностей. Choices: `false` `true`
entity_fan_status_change boolean	Изменение состояния вентилятора сущности. Choices: `false` `true`
entity_mib_change boolean	Изменение MIB сущности. Choices: `false` `true`
entity_module_inserted boolean	Вставлен модуль сущности. Choices: `false` `true`
entity_module_removed boolean	Удален модуль сущности. Choices: `false` `true`
entity_module_status_change boolean	Изменение состояния модуля сущности. Choices: `false` `true`
entity_power_out_change boolean	Изменение отключения питания сущности. Choices: `false` `true`
entity_power_status_change boolean	Изменение состояния питания сущности. Choices: `false` `true`
entity_sensor boolean	Датчик сущности. Choices: `false` `true`
entity_unrecognised_module boolean	Нераспознанный модуль сущности. Choices: `false` `true`
feature_control dictionary	Ловушки управления функциями.
ciscoFeatOpStatusChange boolean	Уведомление об изменении состояния операции функции. Choices: `false` `true`
enable boolean	Включить ловушки управления функциями. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
featureOpStatusChange boolean	Уведомление об изменении состояния операции функции. Choices: `false` `true`

generic dictionary	Общие ловушки.
coldStart boolean	Общая ловушка coldStart. Choices: `false` `true`
enable boolean	Включить общие ловушки. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
warmStart boolean	Общая ловушка warmStart. Choices: `false` `true`
license dictionary	Ловушки лицензирования.
enable boolean	Включить ловушки лицензирования. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
notify_license_expiry boolean	Уведомление о истечении срока действия лицензии. Choices: `false` `true`
notify_license_expiry_warning boolean	Уведомление о предупреждении об истечении срока действия лицензии. Choices: `false` `true`
notify_licensefile_missing boolean	Уведомление об отсутствии файла лицензии. Choices: `false` `true`
notify_no_license_for_feature boolean	Уведомление об отсутствии установленной лицензии для функции. Choices: `false` `true`
link dictionary	Ловушки соединения.
cErrDisableInterfaceEventRev1 boolean	Уведомление о состоянии отключения по ошибке. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
cieLinkDown boolean	Уведомление Cisco о отключении расширенного состояния соединения. Choices: `false` `true`
cieLinkUp boolean	Уведомление Cisco о включении расширенного состояния соединения. Choices: `false` `true`
cisco_xcvr_mon_status_chg boolean	Уведомление об изменении состояния монитора трансивера интерфейса Cisco. Choices: `false` `true`
cmn_mac_move_notification boolean	Ловушка перемещения MAC-адреса. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
delayed_link_state_change boolean	Задержка изменения состояния соединения. Choices: `false` `true`
enable boolean	Включить ловушки соединения. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
extended_linkDown boolean	Уведомление IETF об отключении расширенного состояния соединения. Choices: `false` `true`

extended_linkUp boolean	Уведомление о переходе в состояние «включено» в расширенном состоянии связи IETF. Choices: `false` `true`
linkDown boolean	Уведомление о переходе в состояние «выключено» в состоянии связи IETF. Choices: `false` `true`
linkUp boolean	Уведомление о переходе в состояние «включено» в состоянии связи IETF. Choices: `false` `true`
mmode dictionary	Ловушки MMode. Эта опция не поддерживается на коммутаторах MDS.
cseMaintModeChangeNotify boolean	Уведомление об изменении режима технического обслуживания. Choices: `false` `true`
cseNormalModeChangeNotify boolean	Уведомление об изменении обычного режима. Choices: `false` `true`
enable boolean	Включить ловушки mmode. Choices: `false` `true`
ospf dictionary	Ловушки SNMP OSPF.
enable boolean	Включить ловушки SNMP OSPF. Choices: `false` `true`
ospfv3 dictionary	Ловушки SNMP OSPFv3.
enable boolean	Включить ловушки SNMP OSPFv3. Choices: `false` `true`
rf dictionary	Ловушки RF.
enable boolean	Включить ловушки rf. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
redundancy_framework boolean	MIB Redundancy_Framework (RF) Sup switchover. Choices: `false` `true`
rmon dictionary	Ловушки RMON.
enable boolean	Включить ловушки rmon. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
fallingAlarm boolean	Падающая тревога Rmon. Choices: `false` `true`
hcFallingAlarm boolean	Падающая тревога высокой емкости Rmon. Choices: `false` `true`
hcRisingAlarm boolean	Растущая тревога высокой емкости Rmon. Choices: `false` `true`
risingAlarm boolean	Растущая тревога Rmon. Choices: `false` `true`
snmp dictionary	Ловушки SNMP.

authentication boolean	SNMP ловушка аутентификации. Choices: `false` `true`
enable boolean	Включить SNMP ловушки. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
storm_control dictionary	Ловушки контроля шторма.
cpscEventRev1 boolean	Ловушка контроля шторма порта. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
enable boolean	Включить ловушки контроля шторма. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
trap_rate boolean	Количество ловушек в минуту. Choices: `false` `true`
stpx dictionary	Ловушки STP. Этот параметр не поддерживается на коммутаторах MDS.
enable boolean	Включить ловушки STP. Choices: `false` `true`
inconsistency boolean	Включить SNMP STPX MIB InconsistencyUpdate ловушки. Choices: `false` `true`
loop_inconsistency boolean	Включить SNMP STPX MIB LoopInconsistencyUpdate ловушки. Choices: `false` `true`
root_inconsistency boolean	Включить SNMP STPX MIB RootInconsistencyUpdate ловушки. Choices: `false` `true`
syslog dictionary	Включить syslog ловушки.
enable boolean	Включить syslog ловушки. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
message_generated boolean	Уведомление о создании сообщения. Choices: `false` `true`
sysmgr dictionary	Ловушки sysmgr.
cseFailSwCoreNotifyExtended boolean	Уведомление ядра программного обеспечения. Choices: `false` `true`
enable boolean	Включить ловушки sysmgr. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
system dictionary	Системные ловушки.
clock_change_notification boolean	Ловушки уведомления об изменении времени. Choices: `false` `true`
enable boolean	Включить системные ловушки. Этот параметр не поддерживается на коммутаторах MDS. Choices: `false` `true`
upgrade dictionary	Ловушки обновления.

enable boolean	Включить ловушки обновления. Эта опция не поддерживается на коммутаторах MDS. Choices: `false` `true`
upgradeJobStatusNotify boolean	Уведомление о состоянии задания обновления. Choices: `false` `true`
upgradeOpNotifyOnCompletion boolean	Уведомление о глобальном состоянии обновления. Choices: `false` `true`
vtp dictionary	Ловушки VTP. Эта опция не поддерживается на коммутаторах MDS.
enable boolean	Включить ловушки VTP. Choices: `false` `true`
notifs boolean	Включить уведомления vtpConfigRevNumberError vtpConfigDigestEnable vtpConfigRevNumberError vtpConfigDigestError vtpServerDisabled vtpVersionOneDeviceDetected vlanTrunkPortDynamicStatusChange vtpLocalModeChanged vtpVersionInUseChanged. Choices: `false` `true`
vlancreate boolean	Включить уведомление vtpVlanCreated. Choices: `false` `true`
vlandelete boolean	Включить уведомление vtpVlanDeleted. Choices: `false` `true`
users dictionary	Определить пользователей, которые могут получить доступ к механизму SNMP.
auth list / elements=dictionary	Настройки аутентификации пользователей SNMP
authentication dictionary	Параметры аутентификации для пользователя.
algorithm string	Выберите алгоритм аутентификации. Choices: `"md5"` `"sha"` `"sha-256"`
engine_id string	EngineID для настройки целевого пользователя уведомлений (для V3 informs). Это значение должно быть заключено в кавычки в задаче.
localized_key boolean	Указывает, находятся ли пароли в формате локализованного ключа. Choices: `false` `true`
localizedv2_key boolean	Указывает, находятся ли пароли в формате локализованного ключа V2. Choices: `false` `true`
password string	Пароль аутентификации для пользователя (максимальный размер 127). Если это значение локализовано, оно должно быть заключено в кавычки в задаче.
priv dictionary	Параметры шифрования для пользователя.
aes_128 boolean	Использовать 128-битный алгоритм AES для конфиденциальности. Choices: `false` `true`
privacy_password string	Пароль конфиденциальности для пользователя (максимальный размер 130). Если это значение локализовано, оно должно быть заключено в кавычки в задаче.
group string	Имя группы (игнорируется для целевого пользователя уведомлений) (максимальный размер 28).
user string	Имя пользователя (максимальный размер 28).

use_acls список / элементы=словарь	Установить используемые ACL для IPv4 и IPv6.
ipv4 строка	Указать IPv4 ACL, имя ACL после должно быть именем IPv4 ACL.
ipv6 строка	Указать IPv6 ACL, имя ACL после должно быть именем IPv6 ACL.
user строка	Имя пользователя (максимальная длина 28 символов).
running_config строка	Этот параметр используется только со значением parsed. Значение этого параметра должно быть результатом выполнения команды show running-config \| section ‘^snmp-server’ на устройстве NX-OS. Значение parsed считывает конфигурацию из `running_config` параметра и преобразует её в структурированные данные Ansible, согласно спецификации модуля ресурсов. Затем значение возвращается в ключе parsed результата.
state строка	Состояние, в котором должна остаться конфигурация. Состояния `replaced` и `overridden` имеют идентичное поведение для этого модуля. Дополнительная информация содержится в примерах. Доступные значения: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"parsed"` `"gathered"` `"rendered"`

Примечания

Примечание

Проверено на NX-OS 9.3.6 на коммутаторах Cisco Nexus.
Этот модуль работает с подключениями 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 словарь	Результат конфигурации после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands список / элементы=строка	Набор команд, отправленных на удалённое устройство. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["sample command 1", "sample command 2", "sample command 3"]`
gathered список / элементы=строка	Данные об сетевом ресурсе, собранные с удалённого устройства в структурированном формате. Возвращается: когда state имеет значение `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed список / элементы=строка	Родная конфигурация устройства, указанная в параметре running_config, разобранная в структурированные данные согласно спецификации модуля. Возвращается: когда state имеет значение `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered список / элементы=строка	Предоставленная конфигурация в задаче представлена в формате устройства (офлайн). Возвращается: когда state имеет значение `rendered` Пример: `["sample command 1", "sample command 2", "sample command 3"]`

Авторы

Nilashish Chakraborty (@NilashishC)

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

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