SNMP Feature Template

Configure SNMP parameters, including SNMP device name and location, SNMP version, views, and communities, and trap groups.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
snmp_templates	List	`[snmp_templates]`	No

snmp_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[^<>!&" ]{1,128}$`	Yes
description	String		Yes
device_types	List	Choice[`ASR-1001-HX`, `ASR-1001-X`, `ASR-1002-HX`, `ASR-1002-X`, `ASR-1006-X`, `C1101-4P`, `C1101-4PLTEP`, `C1101-4PLTEPW`, `C1109-2PLTEGB`, `C1109-2PLTEUS`, `C1109-2PLTEVZ`, `C1109-4PLTE2P`, `C1109-4PLTE2PW`, `C1111-4P`, `C1111-4PLTEEA`, `C1111-4PLTELA`, `C1111-4PW`, `C1111-8P`, `C1111-8PLTEEA`, `C1111-8PLTEEAW`, `C1111-8PLTELA`, `C1111-8PLTELAW`, `C1111-8PW`, `C1111X-8P`, `C1112-8P`, `C1112-8PLTEEA`, `C1112-8PLTEEAWE`, `C1112-8PWE`, `C1113-8P`, `C1113-8PLTEEA`, `C1113-8PLTEEAW`, `C1113-8PLTELA`, `C1113-8PLTELAWZ`, `C1113-8PLTEW`, `C1113-8PM`, `C1113-8PMLTEEA`, `C1113-8PMWE`, `C1113-8PW`, `C1116-4P`, `C1116-4PLTEEA`, `C1116-4PLTEEAWE`, `C1116-4PWE`, `C1117-4P`, `C1117-4PLTEEA`, `C1117-4PLTEEAW`, `C1117-4PLTELA`, `C1117-4PLTELAWZ`, `C1117-4PM`, `C1117-4PMLTEEA`, `C1117-4PMLTEEAWE`, `C1117-4PMWE`, `C1117-4PW`, `C1118-8P`, `C1121-4P`, `C1121-4PLTEP`, `C1121-8P`, `C1121-8PLTEP`, `C1121-8PLTEPW`, `C1121X-8P`, `C1121X-8PLTEP`, `C1121X-8PLTEPW`, `C1126-8PLTEP`, `C1126X-8PLTEP`, `C1127-8PLTEP`, `C1127-8PMLTEP`, `C1127X-8PLTEP`, `C1127X-8PMLTEP`, `C1128-8PLTEP`, `C1131-8PLTEPW`, `C1131-8PW`, `C1131X-8PLTEPW`, `C1131X-8PW`, `C1161-8P`, `C1161-8PLTEP`, `C1161X-8P`, `C1161X-8PLTEP`, `C8000V`, `C8200-1N-4T`, `C8200L-1N-4T`, `C8300-1N1S-4T2X`, `C8300-1N1S-6T`, `C8300-2N2S-4T2X`, `C8300-2N2S-6T`, `C8500-12X`, `C8500-12X4QC`, `C8500-20X6C`, `C8500L-8S4X`, `IR-1101`, `IR-1821`, `IR-1831`, `IR-1833`, `IR-1835`, `IR-8140H`, `IR-8140H-P`, `IR-8340`, `ISR-4221`, `ISR-4221X`, `ISR-4321`, `ISR-4331`, `ISR-4351`, `ISR-4431`, `ISR-4451-X`, `ISR-4461`, `ISR1100-4G-XE`, `ISR1100-4GLTEGB-XE`, `ISR1100-4GLTENA-XE`, `ISR1100-6G-XE`, `ISR1100X-4G-XE`, `ISR1100X-6G-XE`]	No
communities	List	`[communities]`	No
contact	String		No
contact_variable	String	Regex: `^[^"~`$&+,]255$`	No
groups	List	`[groups]`	No
location	String		No
location_variable	String	Regex: `^[^"~`$&+,]255$`	No
shutdown	Boolean	`true`, `false`	No
shutdown_variable	String	Regex: `^[^"~`$&+,]255$`	No
trap_target_servers	List	`[trap_target_servers]`	No
users	List	`[users]`	No
views	List	`[views]`	No

communities (sdwan.edge_feature_templates.snmp_templates)

Name	Type	Constraint	Mandatory	Default Value
authorization_read_only	Boolean	`true`, `false`	No	`true`
authorization_read_only_variable	String	Regex: `^[^"~`$&+,]255$`	No
name	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	Yes
view	String	min: `1`, max: `32`	No
view_variable	String	Regex: `^[^"~`$&+,]255$`	No

groups (sdwan.edge_feature_templates.snmp_templates)

Name	Type	Constraint	Mandatory
name	String	min: `1`, max: `32`	Yes
security_level	Choice	`no-auth-no-priv`, `auth-no-priv`, `auth-priv`	Yes
view	String	min: `1`, max: `32`	No
view_variable	String	Regex: `^[^"~`$&+,]255$`	No

trap_target_servers (sdwan.edge_feature_templates.snmp_templates)

Name	Type	Constraint	Mandatory
community_name	String	starts_with: $CRYPT_CLUSTER$	No
community_name_variable	String	Regex: `^[^"~`$&+,]255$`	No
ip	IP		No
ip_variable	String	Regex: `^[^"~`$&+,]255$`	No
source_interface	String		No
source_interface_variable	String	Regex: `^[^"~`$&+,]255$`	No
udp_port	Integer	min: `1`, max: `65535`	No
udp_port_variable	String	Regex: `^[^"~`$&+,]255$`	No
user	String	min: `1`, max: `32`	No
user_variable	String	Regex: `^[^"~`$&+,]255$`	No
vpn_id	Integer	min: `0`, max: `65530`	No
vpn_id_variable	String	Regex: `^[^"~`$&+,]255$`	No

users (sdwan.edge_feature_templates.snmp_templates)

Name	Type	Constraint	Mandatory
authentication_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
authentication_password_variable	String	Regex: `^[^"~`$&+,]255$`	No
authentication_protocol	Choice	`md5`, `sha`	No
authentication_protocol_variable	String	Regex: `^[^"~`$&+,]255$`	No
name	String	min: `1`, max: `32`	Yes
group	String	min: `1`, max: `32`	No
group_variable	String	Regex: `^[^"~`$&+,]255$`	No
privacy_password	String	starts_with: $CRYPT_CLUSTER$ , min: `1`, max: `128`	No
privacy_password_variable	String	Regex: `^[^"~`$&+,]255$`	No
privacy_protocol	Choice	`aes-cfb-128`, `aes-256-cfb-128`	No
privacy_protocol_variable	String	Regex: `^[^"~`$&+,]255$`	No

views (sdwan.edge_feature_templates.snmp_templates)

Name	Type	Constraint	Mandatory	Default Value
name	String	min: `1`, max: `32`	Yes
oids	List	`[oids]`	Yes

oids (sdwan.edge_feature_templates.snmp_templates.views)

Name	Type	Constraint	Mandatory
id	String	Regex: `^[0-9.]+$`	No
id_variable	String	Regex: `^[^"~`$&+,]255$`	No
exclude	Boolean	`true`, `false`	No
exclude_variable	String	Regex: `^[^"~`$&+,]255$`	No

Examples

Example-1: Enhanced Network Visibility with SNMP Templates in SD-WAN

A large enterprise with multiple branch offices needs a centralized SNMP monitoring solution for its SD-WAN edge devices. The customer requires secure and scalable SNMP configuration across different router models to enable network monitoring, fault detection, and performance management. The solution must support SNMPv3 with authentication and encryption, multiple SNMP users, and trap servers to send alerts for critical network events. Additionally, the customer wants a template-based approach for consistent configuration across devices while allowing flexibility for customization.

This configuration ensures secure and efficient SNMP monitoring for SD-WAN edge devices, allowing centralized network visibility and real-time alerting using SNMP traps.

sdwan:
  edge_feature_templates:
    snmp_templates:
      - name: Enterprise_SNMP_Config
        description: SNMP configuration for branch routers
        device_types:
          - ISR-4331
          - ISR-4351
          - C1111-8P
          - C8300-1N1S-4T2X
        communities:
          - name: $CRYPT_CLUSTER$_public
            authorization_read_only: true
        groups:
          - name: snmpv3_group
            security_level: auth-priv
            view: snmpv3_view
        users:
          - name: snmpadmin
            authentication_protocol: sha
            authentication_password: $CRYPT_CLUSTER$_auth_pass
            privacy_protocol: aes-cfb-128
            privacy_password: $CRYPT_CLUSTER$_priv_pass
            group: snmpv3_group
        trap_target_servers:
          - ip: 192.168.1.100
            community_name: $CRYPT_CLUSTER$_public
            udp_port: 162
            source_interface: GigabitEthernet0/0
        views:
          - name: snmpv3_view
            oids:
              - id: 1.3.6.1.2.1
                exclude: false