Snmpv3Notify Function

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
Snmpv3Notify Function
C
BOOL Snmpv3Notify(
    SNMP_ID var, 
    SNMP_VAL val, 
    SNMP_INDEX index, 
    UINT8 targetIndex
);
Description

This function creates SNMPv3 trap PDU and sends it to previously specified remoteHost.

Preconditions

TRAP event is triggered.

Parameters
Parameters 
Description 
var 
SNMP var ID that is to be used in notification 
val 
Value of var. Only value of BYTE, WORD or DWORD can be sent. 
index 
Index of var. If this var is a single,index would be 0, or else if this var Is a sequence, index could be any value from 0 to 127 targetIndex -index of the 'gSnmpv3TrapConfigData' table's security user name for which the TRAP PDU message header to constructed. 
Return Values
Return Values 
Description 
TRUE 
if SNMP notification was successful sent. This does not guarantee that remoteHost recieved it. 
FALSE 
Notification sent failed. 
This would fail under following contions 
1) Given SNMP_BIB_FILE does not exist in MPFS 2) Given var does not exist. 3) Previously given agentID does not exist 
4) Data type of given var is unknown 
only possible if MPFS itself was corrupted. SNMPV3_MSG_PRIV_FAIL -encryption of the trap msg failed 
SNMPV3_MSG_AUTH_FAIL 
HAMC of the trap msg failed 
Remarks

None

Microchip TCP/IP Stack 5.42.08 - June 15, 2013
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.