Simple Network Management Protocol (SNMP)

This document provides a brief description of the Simple Network Management Protocol (SNMP) OpEN APIs. The SNMP OpEN APIs allow processes outside of the EFOS main process (switchdrvr) access to the SNMP configuration.

Here is a summary of SNMP configuration and management related capabilities

• Configure a new user
• Configure a new group or a table that maps SNMP users to SNMP views
• Create or update an existing view
• Specify a host as the recipient of SNMP notification operations
• Set the community string and access privileges
• Map internal security names for SNMPv1 and SNMPv2 security models to group names
• Create or update an existing filter entry
• Enter the SNMP system location
• Enter the SNMP system name
• Specify the SNMP engine ID on the local device
• Enable or disable specific SNMP Traps
• Enable or disable link status traps per interface
• Create or delete SNMP community with IP address and mask
• Get or Get Next SNMP community with IP address and mask
• Create or delete SNMP trap entry
• Get or Get Next SNMP trap entry

All 'Set' operations affect the Switch behavior and configuration.

Example C Application snmp_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

snmp_example

snmp_example.c is a sample application that demonstrates the use of the SNMP OpEN API. The snmp_example executable is started from the command line. A -v command line option is available which enables verbose mode. In addition to configuring some basic system level objects, such as system name and location, the example performs 3 basic steps;

1. Demonstrates the creation of the supported SNMP features
2. Data retrieval of the recent configuration
3. Several deletion examples

Sample Output (LiNe/LinuxHost platform)

• Test 1: Sets the system name: snmp_example 1 <sysName>
• Test 2: Gets the system name: snmp_example 2
• Test 3: Sets the system location: snmp_example 3 <sysLocation>
• Test 4: Gets the system location: snmp_example 4
• Test 5: Sets the system contact: snmp_example 5 <sysContact>
• Test 6: Gets the system contact: snmp_example 6
• Test 7: Sets the SNMP source interface: snmp_example 7 <intf>
• Test 8: Gets the SNMP source interface: snmp_example 8
• Test 9: Sets the SNMP trap flag mode: snmp_example 9 <trapFlag> <mode>
• Test 10: Gets the SNMP trap flag mode: snmp_example 10 <trapFlag>
• Test 11: Sets the SNMP Engine ID: snmp_example 11 <engineId>
• Test 12: Gets the SNMP Engine ID: snmp_example 12
• Test 13: Deletes the SNMP Engine ID: snmp_example 13
• Test 14: Creates the SNMP user: snmp_example 14 <userName> <groupName> <authProto> <authPwd> <authKey> <privProto> <privPwd> <privKey> <engineId>
• Test 15: Gets the SNMP user details configured for a given user name: snmp_example 15 <userName>
• Test 16: Gets all the SNMP users configured: snmp_example 16
• Test 17: Deletes the SNMP user: snmp_example 17 <userName> <engineId>
• Test 18: Creates the SNMP group: snmp_example 18 <groupName> <securityModel> <securityLevel> <contextPrefix> <readView> <writeView> <notifyView>
• Test 19: Gets the SNMP group details for a given group: snmp_example 19 <groupName>
• Test 20: Gets all the SNMP groups configured: snmp_example 20
• Test 21: Deletes the SNMP group: snmp_example 21 <groupName> <securityModel> <securityLevel> <contextPrefix>
• Test 22: Creates the SNMP filter: snmp_example 22 <filterName> <oidTree> <filterType>
• Test 23: Gets the SNMP filter details for a given filter: snmp_example 23 <filterName>
• Test 24: Gets all the SNMP filters configured: snmp_example 24
• Test 25: Deletes the SNMP filter: snmp_example 25 <filterName> <oidTree>
• Test 26: Creates the SNMP view: snmp_example 26 <viewName> <oidTree> <viewType>
• Test 27: Gets the SNMP view details for a given view: snmp_example 27 <viewName>
• Test 28: Gets all the SNMP views configured: snmp_example 28
• Test 29: Deletes the SNMP view: snmp_example 29 <viewName> <oidTree>
• Test 30: Creates the SNMP host: snmp_example 30 <host> <serverPort> <securityName> <securityModel> <securityLevel> <notifyType> <timeout> <retries> <filter>
• Test 31: Gets the SNMP host details for a given host: snmp_example 31 <host>
• Test 32: Gets all the SNMP hosts configured: snmp_example 32
• Test 33: Deletes the SNMP host: snmp_example 33 <host> <notifyType>
• Test 34: Creates the SNMP community: snmp_example 34 <communityName> <accessType> <viewName> <addr>
• Test 35: Creates the SNMP community along with group: snmp_example 35 <communityName> <groupName> <addr>
• Test 36: Gets the SNMP community details for a given community: snmp_example 36 <communityName>
• Test 37: Gets all the SNMP communities configured: snmp_example 37
• Test 38: Deletes the SNMP community: snmp_example 38 <communityName>
• Test 39: Run API sanity checks: snmp_example 39
• Test 40: Run test for SNMP community create, delete, trap create and delete for Non CONF APIs: snmp_example 40

Example Python Application snmp_example

In addition to snmp_example.c, a python implementation has also been provided for demonstration purposes. This python snmp_example.py script essentially duplicates the snmp_example.c implementation.

Example Ruby Application snmp_example

In addition to snmp_example.c, a ruby implementation has also been provided for demonstration purposes. This ruby snmp_example.rb application essentially duplicates the snmp_example.c implementation.

SNMP CLI/API Cross Reference

OPENAPITRAPMANAGERCONFIGGETNEXICLI Command	OpEN API Reference
(Config)# [no] snmp-server location <location>	openapiSnmpSysLocationSet() openapiSnmpSysLocationGet()
(Config)# [no] snmp-server sysname <sys-name>	openapiSnmpSysNameSet() openapiSnmpSysNameGet()
(Config)# [no] snmp-server contact <contact-name>	openapiSnmpSysContactSet() openapiSnmpSysContactGet()
(Config)# [no] snmp-server engineID local <engine-id> [default]	openapiSnmpLocalEngineIdSet() openapiSnmpLocalEngineIdGet() openapiSnmpLocalEngineIdDelete()
(Config)# [no] snmp-server user <name-name> <group-name> [auth] [auth-key] [remote]	openapiSnmpUserCreate() openapiSnmpUserDelete() openapiSnmpUserGetNext()
(Config)# [no] snmp-server group <group-name> <v1,v2,v3> [context] [read] [write] [notify]	openapiSnmpGroupCreate() openapiSnmpGroupDelete() openapiSnmpGroupGetNext()
(Config)# [no] snmp-server view <view-name> <oid-tree> <excluded, included>	openapiSnmpViewCreate() openapiSnmpViewDelete() openapiSnmpViewGetNext()
(Config)# [no] snmp-server filter <filer-name> <oid-tree> <excluded, included>	openapiSnmpFilterCreate() openapiSnmpFilterDelete() openapiSnmpFilterGetNext()
(Config)# [no] snmp-server host <host-address> <oid-tree> <community-name> [informs] [traps]	openapiSnmpHostCreate() openapiSnmpHostDelete() openapiSnmpHostGetNext()
(Config)# [no] snmp-server community <community-name> [ip-address] [ro] [rw] [su] [view]	openapiSnmpCommunityCreate() openapiSnmpCommunityDelete() openapiSnmpCommunityGetNext()
(Config)# [no] snmp-server community-group <community-name> <group-name> [ip-address]	openapiSnmpCommunityGroupCreate()
(Config)# [no] snmp-server enable traps [acl] [boxs-fan-status] [boxs-power-status] [boxs-temp-status] [bgp] [link-mode] [multi-users] [ospfv2] [ospfv3] [stp-mode] [user-auth] [violation]	openapiSnmpTrapFlagSet() openapiSnmpTrapFlagGet()
(Config)# [no] snmptrap source-interface <slot/port> [loopback] [tunnel] [vlan]	openapiSnmpTrapSrcIntfSet() openapiSnmpTrapSrcIntfGet()
(Config)# [no] snmp-server community <community-name> [ip-address] [ip-mask] [mode] [status]	openapiSnmpCommunityAndIPAddrCreate() openapiSnmpCommunityAndIPAddrDelete() openapiSnmpCommunityAndIPAddrGet()
(Config)# [no] snmptrap <community-name> ipaddr <ip-address> [version] [status]	openapiTrapManagerConfigCreate() openapiTrapManagerConfigDelete() openapiTrapManagerConfigGet() openapiTrapManagerConfigIPGetNext()
(Priv-User Mode)# show snmptrap	openapiTrapManagerConfigGet() openapiTrapManagerConfigIPGetNext()
(Priv-User Mode)# show snmpcommunity	openapiSnmpCommunityAndIPAddrGet()