Skip to content

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

Note: Intersight does not return the community strings (access_community_string, trap_community and the community of a trap) once they are set, so changes to them cannot be detected. They are set when the policy is created, but changes to them, and to any other attribute of traps, are not applied to an existing policy. To change them, change them in Intersight, or remove the policy from the data model and add it back so it is recreated.

Diagram
NameTypeConstraintMandatoryDefault Value
intersightClassintersightNo

NameTypeConstraintMandatoryDefault Value
organizationsListorganizationsNo

NameTypeConstraintMandatoryDefault Value
policiesClasspoliciesNo

policies (compute.intersight.organizations)

Section titled “policies (compute.intersight.organizations)”
NameTypeConstraintMandatoryDefault Value
snmpListsnmpNo

snmp (compute.intersight.organizations.policies)

Section titled “snmp (compute.intersight.organizations.policies)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringNo
managedBooleantrue, falseNotrue
tagsListtagsNo
enabledBooleantrue, falseNotrue
portIntegermin: 1, max: 65535No161
access_community_stringStringNo
community_accessChoiceDisabled, Limited, FullNoDisabled
trap_communityStringNo
sys_contactStringNo
sys_locationStringNo
engine_idStringNo
v2Booleantrue, falseNofalse
v3Booleantrue, falseNotrue
usersListusersNo
trapsListtrapsNo

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

Section titled “tags (compute.intersight.organizations.policies.snmp)”
NameTypeConstraintMandatoryDefault Value
keyStringYes
valueStringNo
typeChoiceKeyValue, PathTagNo

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

Section titled “users (compute.intersight.organizations.policies.snmp)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
security_levelChoiceAuthPriv, NoAuthNoPriv, AuthNoPrivYesAuthPriv
auth_typeChoiceNA, MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512NoSHA
auth_passwordStringNo
privacy_typeChoiceNA, DES, AESNoAES
privacy_passwordStringNo

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

Section titled “traps (compute.intersight.organizations.policies.snmp)”
NameTypeConstraintMandatoryDefault Value
destinationStringYes
portIntegermin: 1, max: 65535No162
versionChoiceV1, V2, V3YesV3
typeChoiceTrap, InformNoTrap
enabledBooleantrue, falseNotrue
userStringNo
communityStringNo

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