Function xn_snmp

Function xn_snmp_config

xn_snmp_config configures and initializes the SNMP agent.

struct oid { word id[32]; // array of sub-identifiers int len; // number of entries in id }; typedef struct snmp_config_info { char snmp_version[256]; char snmp_contact[256]; char snmp_location[256]; char snmp_sysname[256]; int num_community_get; char community_get[2][20]; int num_community_set; char community_set[2][20]; char community_out_trap[20]; int snmp_services; struct oid snmp_sys_objid; int num_trap_managers; byte trap_manager[1][4]; dword msgMaxSize; } snmp_config_info; int xn_snmp_config(snmp_config_info * snmp_info);

Parameters

snmp_info

Pointer to the configuration information.

return value

Returns 0 if successful, otherwise SOCKET_ERROR. If an error occurred, call xn_getlasterror and xn_geterror_string to return the error value. In addition to the error values listed below, all error values generated by socket may also be set. Error Codes further describes each error.

Possible values for this function are:

Value	Meaning
EFAULT	Invalid parameter, i.e. the length of one of the community names exceeded CFG_SNMP_COMM_LEN.
EIFACECLOSED	Interface is closed (RTIP-32 specific).
ESNMPFULL	The number of community names exceeds the maximum allowed (2) or the number of trap managers exceeds the maximum allowed (1).

xn_snmp_config must be called prior to calling xn_snmp_daemon. xn_snmp_config will allocate one UDP socket.

The members of structure snmp_config must be filled as follows:

Field	Meaning
snmp_version	Text description of the node. This string should include the name and version of the hardware, OS and networking software, etc.
snmp_contact	Name and contact information of the person responsible for this node.
snmp_location	Text description of the location of the node.
snmp_sysname	Fully qualified domain name of this node.
num_community_get	Number of community names in community_get.
community_get	Supported community names in SNMP GET or GETN input messages sent by an SNMP manager. The first value should usually be "public".
num_community_set	Number of community names in community_set.
community_set	Supported community names in input SNMP SET messages sent by an SNMP manager. The first value should usually be "private".
community_out_trap	Community name set in output SNMP trap messages.
snmp_services	System services. A combination of the following bits can be set set for each service provided: 0x40. Applications (e.g. FTP etc.) 0x08. End-to-end (e.g. IP hosts)
snmp_sys_objid	Vendor's authoritative ID; usually allocated within the enterprise subtree, i.e. within {1.3.6.1.4.1} = {43,6,1,4,1}. See below for valid OIDs.
num_trap_managers	Number of managers in trap_manager; must be 0 or 1.
trap_manager[0]	IP address of SNMP managers to send trap information to.
msgMaxSize	Maximum incoming SNMP packet size. If 0, the default value of 1514 is assumed.

Example:

#define ENTERPRISE_OID 43,6,1,4,1 #define ENTERPRISE_SIZE 5 #define MY_ENTERPRISE 5715 static struct oid EnterpriseOID = {{ENTERPRISE_OID, MY_ENTERPRISE}, ENTERPRISE_SIZE + 1}; void do_snmp_init(const BYTE * SNMPManagerAddr) { struct snmp_config_info snmp_info; memset(&snmp_info, 0, sizeof(snmp_info)); strcpy(snmp_info.snmp_version, "Embedded PC, On Time RTOS-32 4.0"); strcpy(snmp_info.snmp_contact, "Joe Smith (508)448-9340"); strcpy(snmp_info.snmp_location, "broom closet, 3rd floor"); strcpy(snmp_info.snmp_sysname, "SNMP Demo"); snmp_info.num_community_get = 1; strcpy(snmp_info.community_get[0], "public"); snmp_info.num_community_set = 1; strcpy(snmp_info.community_set[0], "private"); strcpy(snmp_info.community_out_trap, "private-traps"); // system services (FTP, End-to-end) snmp_info.snmp_services = 0x48; // vendor authoritative ID within enterprise mib OIDCPY(snmp_info.snmp_sys_objid, EnterpriseOID); // tell the SNMP agent where to send traps to snmp_info.num_trap_managers = 1; memcpy(snmp_info.trap_manager[0], SNMPManagerAddr, 4); if (xn_snmp_config(&snmp_info) == SOCKET_ERROR) Error("do_snmp_init - xn_snmp_config failed"); }