SNMP Server

Diagram

Classes

configuration (iosxe.devices)

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

snmp_server (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory
groups	List	`[groups]`	No
users	List	`[users]`	No
chassis_id	String		No
contact	String		No
ifindex_persist	Boolean	`true`, `false`	No
location	String		No
packetsize	Integer	min: `484`, max: `17892`	No
queue_length	Integer	min: `1`, max: `5000`	No
enable_logging_getop	Boolean	`true`, `false`	No
enable_logging_setop	Boolean	`true`, `false`	No
enable_informs	Boolean	`true`, `false`	No
enable_traps	Boolean	`true`, `false`	No
hosts	List	`[hosts]`	No
system_shutdown	Boolean	`true`, `false`	No
source_interface_informs_gigabit_ethernet	String		No
source_interface_informs_ten_gigabit_ethernet	String		No
source_interface_informs_forty_gigabit_ethernet	String		No
source_interface_informs_hundred_gig_e	String		No
source_interface_informs_loopback	Integer	min: `0`, max: `2147483647`	No
source_interface_informs_port_channel	Integer	min: `0`, max: `4294967295`	No
source_interface_informs_port_channel_subinterface	String		No
source_interface_informs_vlan	Integer	min: `0`, max: `65535`	No
source_interface_traps_gigabit_ethernet	String		No
source_interface_traps_ten_gigabit_ethernet	String		No
source_interface_traps_forty_gigabit_ethernet	String		No
source_interface_traps_hundred_gig_e	String		No
source_interface_traps_loopback	Integer	min: `0`, max: `2147483647`	No
source_interface_traps_port_channel	Integer	min: `0`, max: `4294967295`	No
source_interface_traps_port_channel_subinterface	String		No
source_interface_traps_vlan	Integer	min: `0`, max: `65535`	No
trap_source_gigabit_ethernet	String		No
trap_source_ten_gigabit_ethernet	String		No
trap_source_forty_gigabit_ethernet	String		No
trap_source_hundred_gig_e	String		No
trap_source_loopback	Integer	min: `0`, max: `2147483647`	No
trap_source_port_channel	Integer	min: `0`, max: `4294967295`	No
trap_source_port_channel_subinterface	String		No
trap_source_vlan	Integer	min: `0`, max: `65535`	No
traps	Class	`[traps]`	No
snmp_communities	List	`[snmp_communities]`	No
contexts	List	String	No
views	List	`[views]`	No

groups (iosxe.devices.configuration.snmp_server)

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

users (iosxe.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory
username	String		Yes
group	String		Yes
v3_auth_algorithm	Choice	`md5`, `sha`	No
v3_auth_password	String		No
v3_auth_priv_aes_algorithm	Choice	`128`, `192`, `256`	No
v3_auth_priv_aes_password	String		No
v3_auth_priv_aes_access_ipv6_acl	String		No
v3_auth_priv_aes_access_standard_acl	Integer	min: `1`, max: `99`	No
v3_auth_priv_aes_access_acl_name	String		No
v3_auth_priv_des_password	String		No
v3_auth_priv_des_access_ipv6_acl	String		No
v3_auth_priv_des_access_standard_acl	Integer	min: `1`, max: `99`	No
v3_auth_priv_des_access_acl_name	String		No
v3_auth_priv_des3_password	String		No
v3_auth_priv_des3_access_ipv6_acl	String		No
v3_auth_priv_des3_access_standard_acl	Integer	min: `1`, max: `99`	No
v3_auth_priv_des3_access_acl_name	String		No
v3_auth_access_ipv6_acl	String		No
v3_auth_access_standard_acl	Integer	min: `1`, max: `99`	No
v3_auth_access_acl_name	String		No

hosts (iosxe.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory
ip	IP		Yes
community_or_user	String		Yes
version	Choice	`1`, `2c`, `3`	No
encryption	Choice	`0`, `6`, `7`	No

traps (iosxe.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory
snmp_authentication	Boolean	`true`, `false`	No
snmp_coldstart	Boolean	`true`, `false`	No
snmp_linkdown	Boolean	`true`, `false`	No
snmp_linkup	Boolean	`true`, `false`	No
snmp_warmstart	Boolean	`true`, `false`	No
flowmon	Boolean	`true`, `false`	No
entity_perf_throughput_notif	Boolean	`true`, `false`	No
call_home_message_send_fail	Boolean	`true`, `false`	No
call_home_server_fail	Boolean	`true`, `false`	No
tty	Boolean	`true`, `false`	No
ospfv3_config_state_change	Boolean	`true`, `false`	No
ospfv3_config_errors	Boolean	`true`, `false`	No
ospf_config_retransmit	Boolean	`true`, `false`	No
ospf_config_lsa	Boolean	`true`, `false`	No
ospf_nssa_trans_change	Boolean	`true`, `false`	No
ospf_shamlink_interface	Boolean	`true`, `false`	No
ospf_shamlink_neighbor	Boolean	`true`, `false`	No
ospf_errors_enable	Boolean	`true`, `false`	No
ospf_retransmit_enable	Boolean	`true`, `false`	No
lsa_enable	Boolean	`true`, `false`	No
eigrp	Boolean	`true`, `false`	No
auth_framework_sec_violation	Boolean	`true`, `false`	No
rep	Boolean	`true`, `false`	No
vtp	Boolean	`true`, `false`	No
vlancreate	Boolean	`true`, `false`	No
vlandelete	Boolean	`true`, `false`	No
port_security	Boolean	`true`, `false`	No
license	Boolean	`true`, `false`	No
smart_license	Boolean	`true`, `false`	No
cpu_threshold	Boolean	`true`, `false`	No
memory_bufferpeak	Boolean	`true`, `false`	No
stackwise	Boolean	`true`, `false`	No
udld_link_fail_rpt	Boolean	`true`, `false`	No
udld_status_change	Boolean	`true`, `false`	No
fru_ctrl	Boolean	`true`, `false`	No
flash_insertion	Boolean	`true`, `false`	No
flash_removal	Boolean	`true`, `false`	No
flash_lowspace	Boolean	`true`, `false`	No
energywise	Boolean	`true`, `false`	No
power_ethernet_group	Boolean	`true`, `false`	No
power_ethernet_police	Boolean	`true`, `false`	No
entity	Boolean	`true`, `false`	No
pw_vc	Boolean	`true`, `false`	No
envmon	Boolean	`true`, `false`	No
cef_resource_failure	Boolean	`true`, `false`	No
cef_peer_state_change	Boolean	`true`, `false`	No
cef_peer_fib_state_change	Boolean	`true`, `false`	No
cef_inconsistency	Boolean	`true`, `false`	No
isis	Boolean	`true`, `false`	No
ipsla	Boolean	`true`, `false`	No
entity_diag_boot_up_fail	Boolean	`true`, `false`	No
entity_diag_hm_test_recover	Boolean	`true`, `false`	No
entity_diag_hm_thresh_reached	Boolean	`true`, `false`	No
entity_diag_scheduled_test_fail	Boolean	`true`, `false`	No
bfd	Boolean	`true`, `false`	No
ike_policy_add	Boolean	`true`, `false`	No
ike_policy_delete	Boolean	`true`, `false`	No
ike_tunnel_start	Boolean	`true`, `false`	No
ike_tunnel_stop	Boolean	`true`, `false`	No
ipsec_cryptomap_add	Boolean	`true`, `false`	No
ipsec_cryptomap_attach	Boolean	`true`, `false`	No
ipsec_cryptomap_delete	Boolean	`true`, `false`	No
ipsec_cryptomap_detach	Boolean	`true`, `false`	No
ipsec_tunnel_start	Boolean	`true`, `false`	No
ipsec_tunnel_stop	Boolean	`true`, `false`	No
ipsec_too_many_sas	Boolean	`true`, `false`	No
config_copy	Boolean	`true`, `false`	No
config	Boolean	`true`, `false`	No
config_ctid	Boolean	`true`, `false`	No
dhcp	Boolean	`true`, `false`	No
event_manager	Boolean	`true`, `false`	No
hsrp	Boolean	`true`, `false`	No
ipmulticast	Boolean	`true`, `false`	No
msdp	Boolean	`true`, `false`	No
ospf_config_state_change	Boolean	`true`, `false`	No
ospf_config_errors	Boolean	`true`, `false`	No
pim_invalid_pim_message	Boolean	`true`, `false`	No
pim_neighbor_change	Boolean	`true`, `false`	No
pim_rp_mapping_change	Boolean	`true`, `false`	No
bridge_newroot	Boolean	`true`, `false`	No
bridge_topologychange	Boolean	`true`, `false`	No
stpx_inconsistency	Boolean	`true`, `false`	No
stpx_root_inconsistency	Boolean	`true`, `false`	No
stpx_loop_inconsistency	Boolean	`true`, `false`	No
syslog	Boolean	`true`, `false`	No
bgp_cbgp2	Boolean	`true`, `false`	No
nhrp_nhs	Boolean	`true`, `false`	No
nhrp_nhc	Boolean	`true`, `false`	No
nhrp_nhp	Boolean	`true`, `false`	No
nhrp_quota_exceeded	Boolean	`true`, `false`	No
mpls_traffic_eng	Boolean	`true`, `false`	No
mpls_vpn	Boolean	`true`, `false`	No
mpls_rfc_ldp	Boolean	`true`, `false`	No
mpls_ldp	Boolean	`true`, `false`	No
fast_reroute_protected	Boolean	`true`, `false`	No
local_auth	Boolean	`true`, `false`	No
vlan_membership	Boolean	`true`, `false`	No
errdisable	Boolean	`true`, `false`	No
rf	Boolean	`true`, `false`	No
transceiver_all	Boolean	`true`, `false`	No
bulkstat_collection	Boolean	`true`, `false`	No
bulkstat_transfer	Boolean	`true`, `false`	No
mac_notification_change	Boolean	`true`, `false`	No
mac_notification_move	Boolean	`true`, `false`	No
mac_notification_threshold	Boolean	`true`, `false`	No
vrfmib_vrf_up	Boolean	`true`, `false`	No
vrfmib_vrf_down	Boolean	`true`, `false`	No
vrfmib_vnet_trunk_up	Boolean	`true`, `false`	No
vrfmib_vnet_trunk_down	Boolean	`true`, `false`	No

snmp_communities (iosxe.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory
name	String		Yes
view	String		No
permission	Choice	`ro`, `rw`	No
ipv6_acl	String		No
acl	String		No

views (iosxe.devices.configuration.snmp_server)

Name	Type	Constraint	Mandatory
name	String		Yes
mib	String		No
include	Boolean	`true`, `false`	No
exclude	Boolean	`true`, `false`	No

v3_securities (iosxe.devices.configuration.snmp_server.groups)

Name	Type	Constraint	Mandatory
security_level	String		Yes
context_node	String		No
match_node	Choice	`exact`, `prefix`	No
read_node	String		No
write_node	String		No
notify_node	String		No
access_ipv6_acl	String		No
access_standard_acl	Integer	min: `1`, max: `99`	No
access_acl_name	String		No

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        snmp_server: