SNMP Server

SNMP (Simple Network Management Protocol) server configuration enables comprehensive network monitoring and management by providing standardized access to device operational data, configuration parameters, and event notifications through Management Information Bases (MIBs). Support also includes host targets with unencrypted and encrypted community strings (traps and informs), as well as VRF-specific SNMP configuration for isolated trap delivery and context management within each VRF’s routing table.

Diagram

Classes

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
snmp_server	Class	[snmp_server]	No

snmp_server (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
communities	List	[communities]	No
contact	String		No
groups	List	[groups]	No
hosts	List	[hosts]	No
location	String		No
chassis_id	String		No
packetsize	Integer	min: 484, max: 65500	No
trap_timeout	Integer	min: 1, max: 1000	No
queue_length	Integer	min: 1, max: 5000	No
throttle_time	Integer	min: 50, max: 1000	No
overload_control	Integer	min: 0, max: 300	No
overload_throttle_rate	Integer	min: 0, max: 1000	No
trap_source	String		No
trap_source_ipv4	String		No
trap_source_ipv6	String		No
trap_source_port	Integer	min: 1024, max: 65535	No
trap_throttle_time	Integer	min: 10, max: 500	No
trap_authentication_vrf_disable	Boolean	true, false	No
trap_delay_timer	Integer	min: 30, max: 240	No
ipv4_dscp	Any	Integer[min: 0, max: 63] or Choice[af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef] or String[Regex: ^.*[\$\%]\{.*$]	No
ipv6_dscp	Any	Integer[min: 0, max: 63] or Choice[af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef] or String[Regex: ^.*[\$\%]\{.*$]	No
drop_unknown_user	Boolean	true, false	No
drop_report_acl_ipv4	String		No
drop_report_acl_ipv6	String		No
engine_ids	Class	[engine_ids]	No
interfaces	List	[interfaces]	No
mibs	Class	[mibs]	No
oid_poll_stats	Boolean	true, false	No
timeouts_subagent	Integer	min: 1, max: 20	No
timeouts_duplicate	Integer	min: 0, max: 20	No
timeouts_in_qdrop	Integer	min: 0, max: 20	No
timeouts_threshold	Integer	min: 0, max: 100000	No
timeouts_pdu_stats	Integer	min: 1, max: 10	No
logging_threshold_oid_processing	Integer	min: 0, max: 20000	No
logging_threshold_pdu_processing	Integer	min: 0, max: 20000	No
inform_retries	Integer	min: 0, max: 100	No
inform_timeout	Integer	min: 1, max: 42949671	No
inform_pending	Integer	min: 1, max: 4294967295	No
traps	Class	[traps]	No
users	List	[users]	No
views	List	[views]	No
vrfs	List	[vrfs]	No

communities (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
ipv4_acl	String		No
ipv6_acl	String		No
ro	Boolean	true, false	No
rw	Boolean	true, false	No
sdrowner	Boolean	true, false	No
systemowner	Boolean	true, false	No
view	String		No

groups (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
version	Choice	v1, v2c, v3	Yes
v3_security_level	Choice	priv, auth, noauth	No
read_view	String		No
write_view	String		No
notify_view	String		No
context	String		No
ipv4_acl	String		No
ipv6_acl	String		No

hosts (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
informs	List	[informs]	No
traps	List	[traps]	No

engine_ids (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
local	String		No
remote	List	[remote]	No

interfaces (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
notification_linkupdown_enable	Boolean	true, false	No
notification_linkupdown_disable	Boolean	true, false	No
index_persistence	Boolean	true, false	No

mibs (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
cbqosmib_cache	Boolean	true, false	No
cbqosmib_cache_refresh_time	Integer	min: 5, max: 60	No
cbqosmib_cache_service_policy_count	Integer	min: 1, max: 5000	No
cbqosmib_persist	Boolean	true, false	No
cbqosmib_member_stats	Boolean	true, false	No
ifindex_persist	Boolean	true, false	No
trap_link_ietf	Boolean	true, false	No
ifmib_ifalias_long	Boolean	true, false	No
ifmib_stats_cache	Boolean	true, false	No
ifmib_ipsubscriber	Boolean	true, false	No
ifmib_internal_cache_max_duration	Integer	min: 0, max: 60	No
rfmib_entphyindex	Boolean	true, false	No
sensormib_cache	Boolean	true, false	No
mplstemib_cache_timers_garbage_collect	Integer	min: 0, max: 3600	No
mplstemib_cache_timers_refresh	Integer	min: 0, max: 600	No
mplsp2mpmib_cache_timer	Integer	min: 0, max: 600	No
frrmib_cache_timer	Integer	min: 0, max: 600	No
cmplsteextmib_cache_timer	Integer	min: 0, max: 600	No
cmplsteextstdmib_cache_timer	Integer	min: 0, max: 600	No
mroutemib_send_all_vrf	Boolean	true, false	No
notification_log_mib_default	Boolean	true, false	No
notification_log_mib_global_age_out	Integer	min: 1, max: 4294967295	No
notification_log_mib_global_size	Integer	min: 1, max: 15000	No
notification_log_mib_disable	Boolean	true, false	No
notification_log_mib_size	Integer	min: 1, max: 15000	No
entityindex_persist	Boolean	true, false	No

traps (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
snmp_authentication	Boolean	true, false	No
snmp_coldstart	Boolean	true, false	No
snmp_warmstart	Boolean	true, false	No
snmp_linkup	Boolean	true, false	No
snmp_linkdown	Boolean	true, false	No
snmp_all	Boolean	true, false	No
l2vpn_all	Boolean	true, false	No
l2vpn_vc_up	Boolean	true, false	No
l2vpn_vc_down	Boolean	true, false	No
l2vpn_cisco	Boolean	true, false	No
vpls_all	Boolean	true, false	No
vpls_status	Boolean	true, false	No
vpls_full_raise	Boolean	true, false	No
vpls_full_clear	Boolean	true, false	No
bfd	Boolean	true, false	No
config	Boolean	true, false	No
cfm	Boolean	true, false	No
ethernet_oam_events	Boolean	true, false	No
rf	Boolean	true, false	No
sensor	Boolean	true, false	No
mpls_l3vpn_all	Boolean	true, false	No
mpls_l3vpn_vrf_up	Boolean	true, false	No
mpls_l3vpn_vrf_down	Boolean	true, false	No
mpls_l3vpn_mid_threshold_exceeded	Boolean	true, false	No
mpls_l3vpn_max_threshold_exceeded	Boolean	true, false	No
mpls_l3vpn_max_threshold_cleared	Boolean	true, false	No
mpls_l3vpn_max_threshold_reissue_notif_time	Integer	min: 0, max: 2147483647	No
mpls_traffic_eng_cisco	Boolean	true, false	No
mpls_traffic_eng_cisco_ext_bringup_fail	Boolean	true, false	No
mpls_traffic_eng_cisco_ext_insuff_bw	Boolean	true, false	No
mpls_traffic_eng_cisco_ext_preempt	Boolean	true, false	No
mpls_traffic_eng_cisco_ext_reroute_pending	Boolean	true, false	No
mpls_traffic_eng_cisco_ext_reroute_pending_clear	Boolean	true, false	No
mpls_traffic_eng_down	Boolean	true, false	No
mpls_traffic_eng_p2mp_down	Boolean	true, false	No
mpls_traffic_eng_p2mp_up	Boolean	true, false	No
mpls_traffic_eng_reoptimize	Boolean	true, false	No
mpls_traffic_eng_reroute	Boolean	true, false	No
mpls_traffic_eng_up	Boolean	true, false	No
ntp	Boolean	true, false	No
bgp_cbgp_two	Choice	enable, updown	No
bgp_enable	Choice	bgp4_mib, updown	No
hsrp	Boolean	true, false	No
isis_database_overload	Boolean	true, false	No
isis_manual_address_drops	Boolean	true, false	No
isis_corrupted_lsp_detected	Boolean	true, false	No
isis_attempt_to_exceed_max_sequence	Boolean	true, false	No
isis_id_len_mismatch	Boolean	true, false	No
isis_max_area_addresses_mismatch	Boolean	true, false	No
isis_own_lsp_purge	Boolean	true, false	No
isis_sequence_number_skip	Boolean	true, false	No
isis_authentication_type_failure	Boolean	true, false	No
isis_authentication_failure	Boolean	true, false	No
isis_version_skew	Boolean	true, false	No
isis_area_mismatch	Boolean	true, false	No
isis_rejected_adjacency	Boolean	true, false	No
isis_lsp_too_large_to_propagate	Boolean	true, false	No
isis_orig_lsp_buff_size_mismatch	Boolean	true, false	No
isis_protocols_supported_mismatch	Boolean	true, false	No
isis_adjacency_change	Boolean	true, false	No
isis_lsp_error_detected	Boolean	true, false	No
isis_all	Boolean	true, false	No
vrrp_events	Boolean	true, false	No
alarm	Boolean	true, false	No
bridgemib	Boolean	true, false	No
copy_complete	Boolean	true, false	No
entity	Boolean	true, false	No
cisco_entity_ext	Boolean	true, false	No
entity_redundancy_all	Boolean	true, false	No
entity_redundancy_switchover	Boolean	true, false	No
entity_redundancy_status	Boolean	true, false	No
entity_state_switchover	Boolean	true, false	No
entity_state_operstatus	Boolean	true, false	No
flash_insertion	Boolean	true, false	No
flash_removal	Boolean	true, false	No
fru_ctrl	Boolean	true, false	No
ipsla	Boolean	true, false	No
mpls_ldp_down	Boolean	true, false	No
mpls_ldp_up	Boolean	true, false	No
mpls_ldp_threshold	Boolean	true, false	No
pim_neighbor_change	Boolean	true, false	No
pim_interface_state_change	Boolean	true, false	No
pim_invalid_message_received	Boolean	true, false	No
pim_rp_mapping_change	Boolean	true, false	No
power	Boolean	true, false	No
syslog	Boolean	true, false	No
system	Boolean	true, false	No

users (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
group	String		Yes
version	Choice	v1, v2c, v3	Yes
ipv4_acl	String		No
ipv6_acl	String		No
systemowner	Boolean	true, false	No
v3_authentication	Class	[v3_authentication]	No
v3_privacy	Class	[v3_privacy]	No

views (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
mibs	List	[mibs]	No

vrfs (iosxr.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory	Default Value
vrf	String		Yes
hosts	List	[hosts]	No
contexts	List	[contexts]	No

informs (iosxr.devices.configuration.snmp_server.hosts)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
encryption_type	Choice	unencrypted, default, aes	Yes
version	Choice	v1, v2c, v3	Yes
udp_port	Integer	min: 1, max: 65535	No
v3_security_level	Choice	auth, noauth, priv	No

remote (iosxr.devices.configuration.snmp_server.engine_ids)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
id	String		Yes
udp_port	Integer	min: 1, max: 65535	Yes

v3_authentication (iosxr.devices.configuration.snmp_server.users)

Name	Type	Constraint	Mandatory	Default Value
algorithm	Choice	md5, sha, sha-256, sha-512	Yes
encryption_type	Choice	default, aes	No
password	String		Yes

v3_privacy (iosxr.devices.configuration.snmp_server.users)

Name	Type	Constraint	Mandatory	Default Value
algorithm	Choice	aes-128, aes-192, aes-256	Yes
encryption_type	Choice	default, aes	No
password	String		Yes

mibs (iosxr.devices.configuration.snmp_server.views)

Name	Type	Constraint	Mandatory	Default Value
id	String		Yes
scope	Choice	included, excluded	Yes

hosts (iosxr.devices.configuration.snmp_server.vrfs)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
informs	List	[informs]	No
traps	List	[traps]	No

contexts (iosxr.devices.configuration.snmp_server.vrfs)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

informs (iosxr.devices.configuration.snmp_server.vrfs.hosts)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
encryption_type	Choice	unencrypted, default, aes	Yes
version	Choice	v1, v2c, v3	Yes
udp_port	Any	Integer[min: 1, max: 65535] or Choice[default] or String[Regex: ^.*[\$\%]\{.*$]	No
v3_security_level	Choice	auth, noauth, priv	No

Data Normalization

DSCP Values

SNMP Server DSCP fields accept both numeric and named string values.

• ipv4_dscp / ipv6_dscp: integer 0-63 or named value (e.g., ef, af11, cs3)

Both formats can be used interchangeably. The normalization layer automatically converts integer values to their named equivalents before sending to the device, preventing configuration drift.

Sample CLI Configuration:

The following configuration describes how to set up various SNMP parameters on a Cisco IOS-XR device.

snmp-server location "My location"
snmp-server contact "My contact"
snmp-server trap source Loopback10
snmp-server traps rf
snmp-server traps bfd
snmp-server traps bgp cbgp-two enable
snmp-server traps bgp enable cisco-bgp4-mib
snmp-server traps ntp
snmp-server traps ethernet oam events
snmp-server traps copy-complete
snmp-server traps snmp linkup
snmp-server traps snmp linkdown
snmp-server traps power
snmp-server traps config
snmp-server traps entity
snmp-server traps system
snmp-server traps bridgemib
snmp-server traps entity-state operstatus
snmp-server traps entity-redundancy all
snmp-server traps sensor
snmp-server traps fru-ctrl
snmp-server traps isis database-overload
snmp-server traps isis manual-address-drops
snmp-server traps isis corrupted-lsp-detected
snmp-server traps isis adjacency-change
snmp-server traps l2vpn all
snmp-server traps l2vpn vc-up
snmp-server traps l2vpn vc-down
snmp-server user USER1 GROUP1 v3 auth md5 encrypted 073C05626E2A4841141D priv aes 128 encrypted 073C05626E2A4841141D IPv4 ACL1 systemowner
snmp-server user USER2 GROUP1 v3 auth sha encrypted 080D7A1A10151A190B priv aes 128 encrypted 073C05626E2A4841141D IPv4 ACL2
snmp-server group GROUP1 v3 priv read VIEW1 write VIEW2 context CONTEXT1 notify VIEW3 IPv4 ACL1 IPv6 ACL2
snmp-server community public view VIEW1 RO IPv4 ACL1
snmp-server community private view VIEW2 RW systemowner IPv4 ACL2 IPv6 ACL3
snmp-server view VIEW1 1.3.6.1.2.1.1 included
snmp-server view VIEW2 1.3.6.1.2.1 included
snmp-server view VIEW2 1.3.6.1.2.1.11 excluded
snmp-server vrf VRF1 host 11.11.11.11 traps COMMUNITY1 version 3 auth

SNMP Server Examples

Example-1: Basic SNMP Server configuration with location and contact.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          location: "Data Center A"
          contact: "admin@example.com"

Example-2: SNMP Server with trap configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          location: "Data Center B"
          trap_source: Loopback0
          traps:
            rf: true
            bfd: true
            bgp_cbgp_two: enable
            bgp_enable: bgp4_mib
            ntp: true
            ethernet_oam_events: true
            copy_complete: true
            snmp_linkup: true
            snmp_linkdown: true
            power: true
            config: true
            entity: true
            system: true
            bridgemib: true
            entity_state_operstatus: true
            entity_redundancy_all: true
            sensor: true
            fru_ctrl: true
            isis_database_overload: true
            isis_manual_address_drops: true
            isis_corrupted_lsp_detected: true
            isis_adjacency_change: true
            l2vpn_all: true
            l2vpn_vc_up: true
            l2vpn_vc_down: true

Example-3: SNMP Server with SNMPv3 users and groups.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          location: "Data Center C"
          contact: "netops@example.com"
          users:
            - name: snmp_admin
              group: admin_group
              version: v3
              ipv4_acl: MGMT_ACL
              systemowner: true
              v3_authentication:
                algorithm: md5
                encryption_type: aes
                password: "encrypted_password"
          groups:
            - name: admin_group
              version: v3
              v3_security_level: priv
              read_view: all_view
              write_view: config_view
              ipv4_acl: MGMT_ACL

Example-4: SNMP Server with SNMPv2c communities.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          location: "Branch Office"
          communities:
            - name: public
              view: read_only_view
              ro: true
              ipv4_acl: SNMP_RO_ACL
            - name: private
              view: read_write_view
              rw: true
              systemowner: true
              ipv4_acl: SNMP_RW_ACL

Example-5: SNMP Server hosts with encrypted communities.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          hosts:
            - address: 11.11.11.11
              traps:
                - community: COMMUNITY1
                  encryption_type: unencrypted
                  version: v3
                  v3_security_level: auth
                - community: "15021E0E082328"
                  encryption_type: default
                  version: v2c
              informs:
                - community: COMMUNITY2
                  encryption_type: unencrypted
                  udp_port: 1100
                  version: v2c
                - community: "06253E2C5A471E1C5E"
                  encryption_type: aes
                  version: v3
                  v3_security_level: auth

Example-6: SNMP Server MIB settings with CBQoSMIB caching and interface configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          mibs:
            cbqosmib_cache: true
            cbqosmib_cache_refresh_time: 30
            cbqosmib_cache_service_policy_count: 100
            cbqosmib_persist: true
            cbqosmib_member_stats: true
            ifmib_ifalias_long: true
            ifmib_stats_cache: true
            ifindex_persist: true
            trap_link_ietf: true
          interfaces:
            - name: GigabitEthernet0/0/0/1
              notification_linkupdown_disable: true
              index_persistence: true

SNMP Server VRF Examples

VRF-specific SNMP configuration applies trap destinations and contexts to individual VRFs and is used for isolated SNMP monitoring within each VRF context. These settings define how the router delivers SNMP traps and informs for applications, services, and routing protocols operating within that VRF’s routing table.

Example-1: SNMP Server VRF with hosts, encrypted communities, and contexts.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        snmp_server:
          vrfs:
            - vrf: VRF1
              hosts:
                - address: 11.11.11.11
                  traps:
                    - community: COMMUNITY1
                      encryption_type: unencrypted
                      version: v3
                      v3_security_level: auth
                    - community: "15021E0E082328"
                      encryption_type: default
                      version: v2c
                  informs:
                    - community: COMMUNITY2
                      encryption_type: unencrypted
                      udp_port: 1100
                      version: v2c
                    - community: "06253E2C5A471E1C5E"
                      encryption_type: aes
                      version: v3
                      v3_security_level: auth
              contexts:
                - name: CONTEXT1