SNMP Pod Policy

Location in GUI: Fabric Policies » Policies » Pod » SNMP

Diagram

Classes

pod_policies (apic.fabric_policies)

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

snmp_policies (apic.fabric_policies.pod_policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
admin_state	Boolean	true, false	No	true
location	String	min: 0, max: 512	No
contact	String	min: 0, max: 255	No
users	List	[users]	No
communities	List	String[min: 0, max: 32]	No
trap_forwarders	List	[trap_forwarders]	No
clients	List	[clients]	No

users (apic.fabric_policies.pod_policies.snmp_policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
description	String	Regex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$	No
privacy_type	Choice	none, des, aes-128	No	aes-128
privacy_key	String	min: 8, max: 130	No
authorization_type	Choice	hmac-md5-96, hmac-sha1-96, hmac-sha2-224, hmac-sha2-256, hmac-sha2-384, hmac-sha2-512	No	hmac-sha1-96
authorization_key	String	min: 8, max: 130	Yes

trap_forwarders (apic.fabric_policies.pod_policies.snmp_policies)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		No
port	Integer	min: 0, max: 65535	No	162

clients (apic.fabric_policies.pod_policies.snmp_policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
description	String	Regex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$	No
mgmt_epg	Choice	inb, oob	Yes
entries	List	[entries]	No

entries (apic.fabric_policies.pod_policies.snmp_policies.clients)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[a-zA-Z0-9_.:-]{1,64}$	Yes
ip	IP		Yes

Examples

Simple example:

apic:
  fabric_policies:
    pod_policies:
      snmp_policies:
        - name: SNMP1
          communities:
            - abcABC123
          clients:
            - name: CLIENTS
              entries:
                - name: NMS1
                  ip: 1.1.1.1

Full example:

apic:
  fabric_policies:
    pod_policies:
      snmp_policies:
        - name: SNMP1
          admin_state: true
          location: LOCATION
          contact: CONTACT
          users:
            - name: USER1
              description: Description of USER1
              privacy_type: aes-128
              privacy_key: Key123456
              authorization_type: hmac-sha1-96
              authorization_key: Key123456
          communities:
            - abcABC123
          clients:
            - name: CLIENTS
              description: Description of CLIENTS
              mgmt_epg: inb
              entries:
                - name: NMS1
                  ip: 1.1.1.1