SNMP Policy

An SNMP Policy configures the SNMP agent on UCS servers and IMC endpoints, including community strings, SNMPv3 users, and trap destinations.

Location in Intersight GUI: Policies » SNMP

Diagram

Classes

policies (compute.intersight.organizations)

Name	Type	Constraint	Mandatory	Default Value
snmp	List	[snmp]	No

snmp (compute.intersight.organizations.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
description	String		No
managed	Boolean	true, false	No	true
tags	List	[tags]	No
enabled	Boolean	true, false	No	true
port	Integer	min: 1, max: 65535	No	161
access_community_string	String		No
community_access	Choice	Disabled, Limited, Full	No	Disabled
trap_community	String		No
sys_contact	String		No
sys_location	String		No
engine_id	String		No
v2	Boolean	true, false	No	false
v3	Boolean	true, false	No	true
users	List	[users]	No
traps	List	[traps]	No

tags (compute.intersight.organizations.policies.snmp)

Name	Type	Constraint	Mandatory	Default Value
key	String		Yes
value	String		Yes

users (compute.intersight.organizations.policies.snmp)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
security_level	Choice	AuthPriv, NoAuthNoPriv, AuthNoPriv	Yes	AuthPriv
auth_type	Choice	NA, MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512	No	SHA
auth_password	String		No
privacy_type	Choice	NA, DES, AES	No	AES
privacy_password	String		No

traps (compute.intersight.organizations.policies.snmp)

Name	Type	Constraint	Mandatory	Default Value
destination	String		Yes
port	Integer	min: 1, max: 65535	No	162
version	Choice	V1, V2, V3	Yes	V3
type	Choice	Trap, Inform	No	Trap
enabled	Boolean	true, false	No	true
user	String		No
community	String		No

Examples

Example-1: Configure a basic SNMPv3-only SNMP policy with one user and one trap destination.

compute:
  intersight:
    organizations:
      - name: MyOrg
        policies:
          snmp:
            - name: MySnmpPolicy
              enabled: true
              v3: true
              sys_contact: admin@example.com
              sys_location: "DC1 Row 3 Rack 12"
              users:
                - name: snmpuser
                  security_level: AuthPriv
                  auth_type: SHA
                  auth_password: !env SNMP_AUTH_PASSWORD
                  privacy_type: AES
                  privacy_password: !env SNMP_PRIV_PASSWORD
              traps:
                - destination: 10.0.0.100
                  version: V3
                  user: snmpuser
              tags:
                - key: env
                  value: prod

Example-2: Configure an SNMP policy with both SNMPv2c and SNMPv3 enabled.

compute:
  intersight:
    organizations:
      - name: MyOrg
        policies:
          snmp:
            - name: MixedSnmpPolicy
              enabled: true
              v2: true
              v3: true
              access_community_string: public
              community_access: Limited
              users:
                - name: snmpv3user
                  security_level: AuthPriv
                  auth_type: SHA-256
                  auth_password: !env SNMP_AUTH_PASSWORD
                  privacy_type: AES
                  privacy_password: !env SNMP_PRIV_PASSWORD
              traps:
                - destination: syslog.example.com
                  version: V2
                  community: traps
                  type: Trap