NetSNMP: SNMP Agent

Events generated by the Network - SNMP Agent functions. More...

Functions
__STATIC_INLINE void	EvrNetSNMP_InitAgent (void)
	Event on SNMP agent initialize (Op)
__STATIC_INLINE void	EvrNetSNMP_GetSocketFailed (void)
	Event on SNMP agent failed to allocate UDP socket (Error)
__STATIC_INLINE void	EvrNetSNMP_ViewCommunity (const char *community, uint32_t length)
	Event on SNMP agent display community (Op)
__STATIC_INLINE void	EvrNetSNMP_SetCommunity (const char *community, uint32_t length)
	Event on netSNMP_SetCommunity (API)
__STATIC_INLINE void	EvrNetSNMP_SetCommunityInvalidParam (void)
	Event on netSNMP_SetCommunity invalid parameter (Error)
__STATIC_INLINE void	EvrNetSNMP_SetMibTable (uint32_t num_entries)
	Event on netSNMP_SetMIB_Table (API)
__STATIC_INLINE void	EvrNetSNMP_SetMibTableInvalidParam (void)
	Event on netSNMP_SetMIB_Table invalid parameter (Error)
__STATIC_INLINE void	EvrNetSNMP_Trap (const uint8_t *ip4_addr, uint8_t generic, uint8_t specific, uint16_t nobj)
	Event on netSNMP_Trap (API)
__STATIC_INLINE void	EvrNetSNMP_TrapInvalidParameter (void)
	Event on netSNMP_Trap invalid parameter (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapMibTableNotSet (void)
	Event on netSNMP_Trap invalid parameter (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapMissingSysObjectId (void)
	Event on netSNMP_Trap missing 'sysObjectID' object in MIB table (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapGenericTrapInvalid (uint8_t generic, uint8_t max_generic)
	Event on netSNMP_Trap generic trap invalid (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapTooManyObjects (int32_t nobj, int32_t max_nobj)
	Event on netSNMP_Trap maximum number of objects exceeded (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapObjectNotExisting (int32_t obj, int32_t max_obj)
	Event on netSNMP_Trap requested TLV object not existing in MIB table (Error)
__STATIC_INLINE void	EvrNetSNMP_TrapMessageTooBig (uint16_t size, uint16_t max_size)
	Event on netSNMP_Trap generated message too big (Error)
__STATIC_INLINE void	EvrNetSNMP_MibAddObject (int32_t obj, uint8_t obj_type)
	Event on SNMP add MIB object to SNMP message (Detail)
__STATIC_INLINE void	EvrNetSNMP_ViewObjectId (const char *oid, uint32_t length)
	Event on SNMP display object ID (Detail)
__STATIC_INLINE void	EvrNetSNMP_ViewObjectVal (uint8_t type, uint32_t val)
	Event on SNMP display object value (Detail)
__STATIC_INLINE void	EvrNetSNMP_ViewObjectAddr (const uint8_t *ip4_addr)
	Event on SNMP display object IP address (Detail)
__STATIC_INLINE void	EvrNetSNMP_ViewObjectVar (uint8_t type, const void *value, uint32_t length)
	Event on SNMP display object value (Detail)
__STATIC_INLINE void	EvrNetSNMP_ReceiveFrame (const uint8_t *ip4_addr, uint32_t length)
	Event on SNMP receive frame (Op)
__STATIC_INLINE void	EvrNetSNMP_FrameTooShort (uint32_t length, uint32_t min_length)
	Event on SNMP receive frame is too short (Error)
__STATIC_INLINE void	EvrNetSNMP_FrameProtocolError (void)
	Event on SNMP received frame protocol error detected (Error)
__STATIC_INLINE void	EvrNetSNMP_VersionNotSupported (int32_t version)
	Event on SNMP received protocol version not supported (Op)
__STATIC_INLINE void	EvrNetSNMP_WrongCommunityReceived (void)
	Event on SNMP received community wrong (Op)
__STATIC_INLINE void	EvrNetSNMP_InvalidRequestType (uint8_t req_type)
	Event on SNMP received invalid PDU request type (Error)
__STATIC_INLINE void	EvrNetSNMP_ViewRequest (uint8_t req_type, int32_t req_id)
	Event on SNMP display received PDU request type and id (Error)
__STATIC_INLINE void	EvrNetSNMP_TooManyObjectsReceived (int32_t nobj, int32_t max_nobj)
	Event on SNMP received too many TLV objects (Error)
__STATIC_INLINE void	EvrNetSNMP_ObjectNotFound (int32_t obj)
	Event on SNMP receive message object not found in the MIB table (Error)
__STATIC_INLINE void	EvrNetSNMP_ObjectWrongType (int32_t obj)
	Event on SNMP receive message object type not the same as in the MIB table (Error)
__STATIC_INLINE void	EvrNetSNMP_ObjectReadOnly (int32_t obj)
	Event on SNMP write read-only object not allowed (Error)
__STATIC_INLINE void	EvrNetSNMP_ObjectWriteFailed (int32_t obj)
	Event on SNMP object write attempt failed for unknown reason (Error)
__STATIC_INLINE void	EvrNetSNMP_SendErrorStatus (uint8_t stat, uint8_t obj_index)
	Event on SNMP send error status response to a SNMP request (Op)
__STATIC_INLINE void	EvrNetSNMP_ResponseMessageTooBig (uint16_t size, uint16_t max_size)
	Event on SNMP response message would be too big (Error)
__STATIC_INLINE void	EvrNetSNMP_SendGetResponse (int32_t req_id)
	Event on SNMP send get-response to a SNMP request (Op)
__STATIC_INLINE void	EvrNetSNMP_UninitAgent (void)
	Event on SNMP agent de-initialize (Op)

Description

Events generated by the Network - SNMP Agent functions.

The SNMP Agent functions generate events that make it easier to troubleshoot errors, and allow the user to understand how the SNMP agent works.

Function Documentation

EvrNetSNMP_FrameProtocolError()

__STATIC_INLINE void EvrNetSNMP_FrameProtocolError

(

void

)

Event on SNMP received frame protocol error detected (Error)

The event FrameProtocolError is created when the network library detects an error parsing the received frame. The error is most likely in the incorrect encoding of the ASN.1 object within SNMP frame. The frame is discarded.

Value in the Event Recorder shows:

• error

EvrNetSNMP_FrameTooShort()

__STATIC_INLINE void EvrNetSNMP_FrameTooShort	(	uint32_t	length,
		uint32_t	min_length
	)

Event on SNMP receive frame is too short (Error)

Parameters

length	frame length in bytes
min_length	minimum length of the frame

The event FrameTooShort is created when the network library receives the SNMP frame that is too short. The frame is discarded.

Value in the Event Recorder shows:

• len: length of the received frame in bytes.
• min: minimum valid frame length in bytes.

EvrNetSNMP_GetSocketFailed()

__STATIC_INLINE void EvrNetSNMP_GetSocketFailed

(

void

)

Event on SNMP agent failed to allocate UDP socket (Error)

The event GetSocketFailed is created when the SNMP agent is initialized, that is, when the function netInitialize is executed, and the service could not assign the UDP socket. To resolve this error, you must increase the number of available UDP sockets in the UDP socket configuration.

Value in the Event Recorder shows:

• error

EvrNetSNMP_InitAgent()

__STATIC_INLINE void EvrNetSNMP_InitAgent

(

void

)

Event on SNMP agent initialize (Op)

The event InitAgent is created when the SNMP agent is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

• snmp

EvrNetSNMP_InvalidRequestType()

__STATIC_INLINE void EvrNetSNMP_InvalidRequestType

(

uint8_t

req_type

)

Event on SNMP received invalid PDU request type (Error)

Parameters

req_type

PDU request type 0xA0: GetRequest PDU 0xA1: GetNextRequest PDU 0xA2: Response PDU 0xA3: SetRequest PDU 0xA4: Trap PDU

The event InvalidRequestType is created when the network library receives an SNMP frame with a request type that is not allowed or not supported. The frame is discarded.

Value in the Event Recorder shows:

• type: received SNMP request type.

EvrNetSNMP_MibAddObject()

__STATIC_INLINE void EvrNetSNMP_MibAddObject	(	int32_t	obj,
		uint8_t	obj_type
	)

Event on SNMP add MIB object to SNMP message (Detail)

Parameters

obj	object identification number
obj_type	object data type 0x02: Integer Data Type (signed integer) 0x04: Octet String Data Type 0x05: Null Item Data Type 0x06: Object Identifier Data Type 0x30: Sequence Data Type 0x40: IP Address Data Type 0x41: Counter Data Type (pos.integer) 0x42: Gauge Data Type (pos.integer) 0x43: Time Ticks Data Type (pos.integer) 0x44: Opaque Data Type (ASN.1 encoded)

The event MibAddObject is created when the network library adds an object to a generated SNMP trap or SNMP response message.

Value in the Event Recorder shows:

• type: type of the added object.
• index: object index in the SNMP-MIB table.

EvrNetSNMP_ObjectNotFound()

__STATIC_INLINE void EvrNetSNMP_ObjectNotFound

(

int32_t

obj

)

Event on SNMP receive message object not found in the MIB table (Error)

Parameters

obj	object identification number

The event ObjectNotFound is created when the SNMP agent can not find the encoded object from the received frame in the SNMP-MIB table. The frame is discarded and the SNMP agent responds with an error message.

Value in the Event Recorder shows:

• obj: index of requested object.

EvrNetSNMP_ObjectReadOnly()

__STATIC_INLINE void EvrNetSNMP_ObjectReadOnly

(

int32_t

obj

)

Event on SNMP write read-only object not allowed (Error)

Parameters

obj	object identification number

The event ObjectReadOnly is created when the SNMP agent tries to write the read-only object. The frame is discarded and the SNMP agent responds with an error message.

Value in the Event Recorder shows:

• obj: index of reqested object.

EvrNetSNMP_ObjectWriteFailed()

__STATIC_INLINE void EvrNetSNMP_ObjectWriteFailed

(

int32_t

obj

)

Event on SNMP object write attempt failed for unknown reason (Error)

Parameters

obj	object identification number

The event ObjectWriteFailed is created when the SNMP agent tries to write the writtable object but the write operaiton fails. The frame is discarded and the SNMP agent responds with an error message.

Value in the Event Recorder shows:

• obj: index of reqested object.

EvrNetSNMP_ObjectWrongType()

__STATIC_INLINE void EvrNetSNMP_ObjectWrongType

(

int32_t

obj

)

Event on SNMP receive message object type not the same as in the MIB table (Error)

Parameters

obj	object identification number

The event ObjectWrongType is created when the SNMP agent finds inconsisteny in received encoded object type. The types of objects are different. The frame is discarded and the SNMP agent responds with an error message.

Value in the Event Recorder shows:

• obj: index of requested object.

EvrNetSNMP_ReceiveFrame()

__STATIC_INLINE void EvrNetSNMP_ReceiveFrame	(	const uint8_t *	ip4_addr,
		uint32_t	length
	)

Event on SNMP receive frame (Op)

Parameters

ip4_addr	pointer to IPv4 address of the sender
length	frame length in bytes

The event ReceiveFrame is created when the network library receives the SNMP frame.

Value in the Event Recorder shows:

• ip: address of the message sender.
• len: length of the received frame in bytes.

EvrNetSNMP_ResponseMessageTooBig()

__STATIC_INLINE void EvrNetSNMP_ResponseMessageTooBig	(	uint16_t	size,
		uint16_t	max_size
	)

Event on SNMP response message would be too big (Error)

Parameters

size	response message size
max_size	maximum message size allowed

The event ResponseMessageTooBig is created when the SNMP agent can not send a response because the generated response message would exceed the maximum message size.

Value in the Event Recorder shows:

• size: size of the required response message.
• max: maximum size of the response message.

EvrNetSNMP_SendErrorStatus()

__STATIC_INLINE void EvrNetSNMP_SendErrorStatus	(	uint8_t	stat,
		uint8_t	obj_index
	)

Event on SNMP send error status response to a SNMP request (Op)

Parameters

stat	error status
obj_index	error object index

The event SendErrorStatus is created when the SNMP agent responds to an SNMP request with an error message.

Value in the Event Recorder shows:

• error: error status.
• index: index of the erroneous object.

EvrNetSNMP_SendGetResponse()

__STATIC_INLINE void EvrNetSNMP_SendGetResponse

(

int32_t

req_id

)

Event on SNMP send get-response to a SNMP request (Op)

Parameters

req_id

PDU request identifier

The event SendGetResponse is created when the SNMP agent sends a response to a GET or GETNEXT request.

Value in the Event Recorder shows:

• id: request identification number.

EvrNetSNMP_SetCommunity()

__STATIC_INLINE void EvrNetSNMP_SetCommunity	(	const char *	community,
		uint32_t	length
	)

Event on netSNMP_SetCommunity (API)

Parameters

community	pointer to SNMP community string
length	length of the community string

The event SetCommunity is created when the SNMP agent changes the SNMP community of which the SNMP agent is a member. This happens when the netSNMP_SetCommunity function is executed.

Value in the Event Recorder shows:

• community: name of the community to be set.

EvrNetSNMP_SetCommunityInvalidParam()

__STATIC_INLINE void EvrNetSNMP_SetCommunityInvalidParam

(

void

)

Event on netSNMP_SetCommunity invalid parameter (Error)

The event SetCommunityInvalidParam is created when the SNMP agent can not change the community name because the netSNMP_SetCommunity function is called with an invalid input parameter.

Value in the Event Recorder shows:

• error

EvrNetSNMP_SetMibTable()

__STATIC_INLINE void EvrNetSNMP_SetMibTable

(

uint32_t

num_entries

)

Event on netSNMP_SetMIB_Table (API)

Parameters

num_entries

number of entries in MIB table

The event SetMibTable is created when the SNMP agent registers the SNMP-MIB table as the SNMP management database. This happens when the netSNMP_SetMIB_Table function is executed.

Value in the Event Recorder shows:

• entries: number of available entries in the SNMP-MIB table.

EvrNetSNMP_SetMibTableInvalidParam()

__STATIC_INLINE void EvrNetSNMP_SetMibTableInvalidParam

(

void

)

Event on netSNMP_SetMIB_Table invalid parameter (Error)

The event SetMibTableInvalidParam is created when the SNMP agent can not register the SNMP-MIB table because the netSNMP_SetMIB_Table function is called with an invalid input parameter.

Value in the Event Recorder shows:

• error

EvrNetSNMP_TooManyObjectsReceived()

__STATIC_INLINE void EvrNetSNMP_TooManyObjectsReceived	(	int32_t	nobj,
		int32_t	max_nobj
	)

Event on SNMP received too many TLV objects (Error)

Parameters

nobj	number of TLV objects
max_nobj	maximum number of TLV objects

The event TooManyObjectsReceived is created when the SNMP agent receives a frame with an exceeded number of encoded objects. TThe frame is discarded and the SNMP agent responds with an error message.

Value in the Event Recorder shows:

• nobj: number of encoded objects.
• max: maximum number of objects in a message.

EvrNetSNMP_Trap()

__STATIC_INLINE void EvrNetSNMP_Trap	(	const uint8_t *	ip4_addr,
		uint8_t	generic,
		uint8_t	specific,
		uint16_t	nobj
	)

Event on netSNMP_Trap (API)

Parameters

ip4_addr	trap server IPv4 address
generic	generic trap type 0: coldStart trap 1: warmStart trap 2: linkDown trap 3: linkUp trap 4: authenticationFailure trap 5: egpNeighborLoss trap 6: enterpriseSpecific trap
specific	specific trap type for generic enterpriseSpecific trap must be set to 0 for generic traps 0 .. 5
nobj	number of objects in a trap message

The event Trap is created, when the function netSNMP_Trap sends an alert message to the trap manager.

Value in the Event Recorder shows:

• ip: IPv4 address of the trap manager.
• generic: generic trap type.
• specific: specific trap type for enterpriseSecific trap.
• nobj: number of objects encoded in the trap message.

EvrNetSNMP_TrapGenericTrapInvalid()

__STATIC_INLINE void EvrNetSNMP_TrapGenericTrapInvalid	(	uint8_t	generic,
		uint8_t	max_generic
	)

Event on netSNMP_Trap generic trap invalid (Error)

Parameters

generic	invalid generic trap type
max_generic	maximum value for generic trap type

The event TrapGenericTrapInvalid is created when the SNMP agent can not send an alert message because the generic trap number is not valid.

Value in the Event Recorder shows:

• generic: generic trap type.
• max: the highest possible value of the generic trap.

EvrNetSNMP_TrapInvalidParameter()

__STATIC_INLINE void EvrNetSNMP_TrapInvalidParameter

(

void

)

Event on netSNMP_Trap invalid parameter (Error)

The event TrapInvalidParameter is created when the SNMP agent can not send an alert message because the netSNMP_Trap function is called with an invalid input parameter.

Value in the Event Recorder shows:

• error

EvrNetSNMP_TrapMessageTooBig()

__STATIC_INLINE void EvrNetSNMP_TrapMessageTooBig	(	uint16_t	size,
		uint16_t	max_size
	)

Event on netSNMP_Trap generated message too big (Error)

Parameters

size	requested message size
max_size	maximum message size accepted

The event TrapMessageTooBig is created when the SNMP agent can not send an alert message because the trap message generated would exceed the maximum message size.

Value in the Event Recorder shows:

• size: size of the required trap message.
• max: maximum size of the trap message.

EvrNetSNMP_TrapMibTableNotSet()

__STATIC_INLINE void EvrNetSNMP_TrapMibTableNotSet

(

void

)

Event on netSNMP_Trap invalid parameter (Error)

The event TrapMibTableNotSet is created when the SNMP agent can not send an alert message because the MIB table is not registered when the netSNMP_Trap function is called. To resolve this error, you must register a valid SNMP-MIB table using the netSNMP_SetMIB_Table function.

Value in the Event Recorder shows:

• error

EvrNetSNMP_TrapMissingSysObjectId()

__STATIC_INLINE void EvrNetSNMP_TrapMissingSysObjectId

(

void

)

Event on netSNMP_Trap missing 'sysObjectID' object in MIB table (Error)

The event TrapMissingSysObjectId is created when the SNMP agent can not send an alert message because the mandatory sysObjectID object is missing in the SNMP-MIB table. To resolve this error, you must first add the missing object to the table.

Value in the Event Recorder shows:

• error

EvrNetSNMP_TrapObjectNotExisting()

__STATIC_INLINE void EvrNetSNMP_TrapObjectNotExisting	(	int32_t	obj,
		int32_t	max_obj
	)

Event on netSNMP_Trap requested TLV object not existing in MIB table (Error)

Parameters

obj	object identification number
max_obj	maximum value for object identification number

The event TrapObjectNotExisting is created when the SNMP agent can not send an alert message because the requested object is not existing in the registered SNMP-MIB table. To resolve this error, you must correct the obj_list parameter of the netSNMP_Trap function.

Value in the Event Recorder shows:

• obj: index of requested object.
• max: the highest possible index of the object.

EvrNetSNMP_TrapTooManyObjects()

__STATIC_INLINE void EvrNetSNMP_TrapTooManyObjects	(	int32_t	nobj,
		int32_t	max_nobj
	)

Event on netSNMP_Trap maximum number of objects exceeded (Error)

Parameters

nobj	number of TLV objects
max_nobj	maximum number of TLV objects

The event TrapTooManyObjects is created when the SNMP agent can not send an alert message because the number of requested objects exceeds maximum number of objects that can be encoded in the trap message.

Value in the Event Recorder shows:

• nobj: number of requested objects.
• max: maximum number of objects in the trap message.

EvrNetSNMP_UninitAgent()

__STATIC_INLINE void EvrNetSNMP_UninitAgent

(

void

)

Event on SNMP agent de-initialize (Op)

The event UninitAgent is created when the function netUninitialize is executed.

Value in the Event Recorder shows:

• snmp

EvrNetSNMP_VersionNotSupported()

__STATIC_INLINE void EvrNetSNMP_VersionNotSupported

(

int32_t

version

)

Event on SNMP received protocol version not supported (Op)

Parameters

version

received SNMP protocol version 1: SNMPv1 2: SNMPv2 3: SNMPv3

Remarks

Only SNMPv1 is currently supported.

The event VersionNotSupported is created when the network library receives a version of SNMP that is not supported by the network library. The frame is discarded.

Value in the Event Recorder shows:

• ver: received SNMP protocol version.

EvrNetSNMP_ViewCommunity()

__STATIC_INLINE void EvrNetSNMP_ViewCommunity	(	const char *	community,
		uint32_t	length
	)

Event on SNMP agent display community (Op)

Parameters

community	pointer to SNMP community string
length	length of the community string

The event ViewCommunity is created when a network library wants to display a community of which the SNMP agent is a member. Only members of the same community can communicate with each other using the SNMP protocol. The default community name is public.

Value in the Event Recorder shows:

• community: name of the community.

EvrNetSNMP_ViewObjectAddr()

__STATIC_INLINE void EvrNetSNMP_ViewObjectAddr

(

const uint8_t *

ip4_addr

)

Event on SNMP display object IP address (Detail)

Parameters

ip4_addr

pointer to IPv4 address object value

The event ViewObjectAddr is created when the network library wants to display the value of an IP address object.

Value in the Event Recorder shows:

• ip: IPv4 address value.

EvrNetSNMP_ViewObjectId()

__STATIC_INLINE void EvrNetSNMP_ViewObjectId	(	const char *	oid,
		uint32_t	length
	)

Event on SNMP display object ID (Detail)

Parameters

oid	object identification string
length	length of the oid string

The event ViewObjectId is created when the network library wants to display object name information, that is the value of the OID.

Value in the Event Recorder shows:

• oid: object identification name.

EvrNetSNMP_ViewObjectVal()

__STATIC_INLINE void EvrNetSNMP_ViewObjectVal	(	uint8_t	type,
		uint32_t	val
	)

Event on SNMP display object value (Detail)

Parameters

type	object type
val	4-byte object value

Note

Object types: INTEGER, COUNTER, GAUGE, TICKS

The event ViewObjectVal is created when the network library wants to display the value of an integer or unsigned integer object.

The following subtype events are generated:

• ViewObjectVal-Integer for integer object,
• ViewObjectVal-Counter for counter object,
• ViewObjectVal-Gauge for gauge object,
• ViewObjectVal-Ticks for tick object.

Value in the Event Recorder shows:

• val: object value.

EvrNetSNMP_ViewObjectVar()

__STATIC_INLINE void EvrNetSNMP_ViewObjectVar	(	uint8_t	type,
		const void *	value,
		uint32_t	length
	)

Event on SNMP display object value (Detail)

Parameters

type	object type
value	pointer to object value
length	length of the object value

Note

Object types: OID, OCTET_STRING, BYTE_STRING

The event ViewObjectVar is created when the network library wants to display the value of an object of variable length.

The following subtype events are generated:

• ViewObjectVar-OID for OID object,
• ViewObjectVar-String for ascii-string object,
• ViewObjectVar-BString for byte-string object.

ViewObjectVar-OID in the Event Recorder shows:

• oid: object ID value.

ViewObjectVar-String in the Event Recorder shows:

• len: length of the octet-string.
• val: octet-string content in ascii form.

ViewObjectVar-BString in the Event Recorder shows:

• len: length of the byte-string.
• val: byte-string content in hexadecimal form.

EvrNetSNMP_ViewRequest()

__STATIC_INLINE void EvrNetSNMP_ViewRequest	(	uint8_t	req_type,
		int32_t	req_id
	)

Event on SNMP display received PDU request type and id (Error)

Parameters

req_type	PDU request type 0xA0: GetRequest PDU 0xA1: GetNextRequest PDU 0xA2: Response PDU 0xA3: SetRequest PDU 0xA4: Trap PDU
req_id	PDU request identifier

The event ViewRequest is created when the network library wants to display the received SNMP request type and request identification number.

Value in the Event Recorder shows:

• type: SNMP request type.
• id: request identification number.

EvrNetSNMP_WrongCommunityReceived()

__STATIC_INLINE void EvrNetSNMP_WrongCommunityReceived

(

void

)

Event on SNMP received community wrong (Op)

The event WrongCommunityReceived is created when the network library receives the SNMP frame with another community. The frame is discarded.

Value in the Event Recorder shows:

• error