Wind River SNMP API Reference. Wind River SNMP API REFERENCE 10.2

Transcription

1 Wind River SNMP API Reference Wind River SNMP API REFERENCE 10.2

2 Copyright 2007 Wind River Systems, Inc. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means without the prior written permission of Wind River Systems, Inc. Wind River, Tornado, and VxWorks are registered trademarks of Wind River Systems, Inc. The Wind River logo is a trademark of Wind River Systems, Inc. Any third-party trademarks referenced are the property of their respective owners. For further information regarding Wind River trademarks, please see: This product may include software licensed to Wind River by third parties. Relevant notices if any are provided in your product installation at the following location: installdir/product_name/3rd_party_licensor_notice.pdf. Wind River may refer to third-party documentation by listing publications or providing links to third-party Web sites for informational purposes. Wind River accepts no responsibility for the information provided in such third-party documentation. Corporate Headquarters Wind River Systems, Inc. 500 Wind River Way Alameda, CA U.S.A. toll free U.S.: WIND telephone: facsimile: For additional contact information, please visit the Wind River URL: For information on how to contact Customer Support, please visit the following URL: Wind River SNMP API Reference, Mar 07 Part #: DOC ND-00

3 Contents This book provides reference entries that describe the user exits, macros, libraries and routines for Wind River SNMP. For information on programming with Wind River SNMP, see the Wind River SNMP Programmer s Guide. 1. User-Supplied Code Reference Entries This section provides reference entries for each of the Wind River SNMP customer-supplied user-exits. 2. Wind River SNMP Macro Entries This section provides reference entries for each of the Wind River SNMP macros. 3. Wind River SNMP Libraries This section provides reference entries for each of the Wind River SNMP application libraries, arranged alphabetically. Each entry lists the routines found in the library, including a one-line synopsis of each and a general description of their use. Individual reference entries for each of the available functions in these libraries is provided in section Wind River SNMP Routines This section provides reference entries for each of the routines found in the Wind River SNMP application libraries documented in section 3. iii

4 Wind River SNMP API Reference, 10.2 iv

5 1 User-Supplied Code Reference Entries AX_RESPONSE_PREPROCESS process subagent response packets 3 ENVOY_AX_ADD_T indicate when an AgentX packet handler was called 3 ENVOY_AX_ADMIN_T pass an AgentX packet to customer code 4 ENVOY_AX_ERROR_T AgentX error handler 4 ENVOY_AX_SEND_T AgentX send handler 5 ERR_COMPLETE_T error completion routine 6 IO_COMPLETE_T I/O completion routine 7 PROXY_ROUTINE_T translation routine for proxy packets 8 RETRANS_CLEANUP_T notify retransmit cleanup completion routine 9 TRANSPORT_ROUTINE_T transport routine for proxy packets 9 ENVOY_ADD_ENGINE_ADDRESS add an engine ID to the engine table 10 ENVOY_ADD_ENGINE_ID add an engine ID to the engine table 11 ENVOY_AX_CONN_ENTRY return the time, domain and addr for a specified connid 11 ENVOY_AX_COOKIE_CMP compare two AgentX information blocks 12 ENVOY_AX_FIND_MIB find a MIB to use with a given context 13 ENVOY_AX_GET_CONNID return the connection ID for a specific session 13 ENVOY_AX_MA_AC_ADD register a VarBindList in the agent capabilities table 14 ENVOY_AX_MA_AC_CLEAN request subagent to remove session from agent table 14 ENVOY_AX_MA_AC_REMOVE request subagent to remove VarBindList from agent table 15 ENVOY_AX_TRANSLATE_CONTEXT extract context information from SNMP_PKT_T 15 ENVOY_AX_SA_MIB_ROOT_NODE determine the appropriate MIB tree 16 ENVOY_GET_SYSUPTIME return the value for the sysuptime object 17 ENVOY_SET_RETRANS_ID customize outgoing notify numbering scheme 17 ENVOY_SNMPADDR_TO_TADDRESS convert SNMPADDR_T into TAddress and TDomain pair 18 ENVOY_TADDRESS_TO_SNMPADDR convert a TAddress to an SNMPADDR_T 18 SNMP_DH_RAND set the pseudo-random number generator seed 19 SNMP_user_get_encode_buffer allocate memory for an encoded packet 20 SNMP V3 TEST Macros reserve resources requested for a SET operation 20 SNMP V3 BACKOUT Macros free pre-staged information and resources from a failed TEST 26 SNMP V3 SET Macros create, change, or delete a table entry 30 1

6 Wind River SNMP API Reference, 10.2 SNMP V3 UNDO Macros undo a SET error 36 SNMP V3 FINISHED Macros free a packet structure and resources after a SET REQUEST 41 RFC2275 View Method Routine Macros service the RFC2275 view table 42 RFC2275 View TEST Macros reserve resources required for a SET operation 43 RFC2275 View BACKOUT Macros free pre-staged information and resources from a failed TEST 44 RFC2275 View SET Macros create, change, or delete a table entry 45 RFC2275 View UNDO Macros undo a SET error 46 RFC2275 View FINISHED Macros free a packet structure and resources after a SET REQUEST 47 2

7 AX_RESPONSE_PREPROCESS AgentX AX_RESPONSE_PREPROCESS 1 AX_RESPONSE_PREPROCESS process subagent response packets bits32_t AX_RESPONSE_PREPROCESS SNMP_PKT_T *pktp This user-exit provides an application-specific way for programmers to perform processing within the Master Agent for sub-agent response packets using field values found in the SNMP_PKT_T structure. By default this user-exit is defined to NULL. pktp Point to an SNMP_PKT_T structure. None. SEE ALSO ENVOY_AX_CONN_ENTRY, ENVOY_AX_GET_CONNID AgentX ENVOY_AX_ADD_T ENVOY_AX_ADD_T indicate when an AgentX packet handler was called void ENVOY_AX_ADD_T ptr_t cookie This is a prototype for a routine that the envoy_ax_chunk_handler routine calls to indicate to you when a packet handler has been called. Use this function to maintain a reference count on the cookie information in conjunction with calls to the error handler, ENVOY_AX_ERROR_T, to determine when it is safe to free resources associated with cookie. Depending on how the other side of the connection chooses to send its messages, a single call to the stream-to-packet routines may result in 0, 1, or several calls to this routine. cookie Specify the information block that was passed to envoy_ax_chunk_handler. None. SEE ALSO ENVOY_AX_ADMIN_T, envoy_ax_chunk_handler, ENVOY_AX_ERROR_T, ENVOY_AX_SEND_T 3

8 Wind River SNMP API Reference, 10.2 AgentX ENVOY_AX_ADMIN_T ENVOY_AX_ADMIN_T pass an AgentX packet to customer code void ENVOY_AX_ADMIN_T ptr_t cookie, ptr_t ax_pkt This is a prototype for a routine that you can use to pass an AgentX packet to your code. Wind River SNMP calls this routine when a subagent receives a response or close packet. Wind River SNMP can also call ENVOY_AX_ADMIN_T when a master agent receives a notify. Since a notify is an attempt by a subagent to cause a trap to be sent, it is your responsibility to create and send the trap. When the subagent receives a response, check the response to see if it is an error. Wind River SNMP can call this routine before the handler routine returns. ax_pkt Specify an AgentX packet. cookie Specify the information block that you passed to the handler routine. None. SEE ALSO ENVOY_AX_ADD_T, envoy_ax_chunk_handler, ENVOY_AX_ERROR_T, ENVOY_AX_SEND_T AgentX ENVOY_AX_ERROR_T ENVOY_AX_ERROR_T AgentX error handler void ENVOY_AX_ERROR_T ptr_t cookie, int error_stat This is a prototype for a routine that an error handler calls to indicate that the handler is finished with cookie and that your code may free any resources associated with it. Wind River SNMP calls it once for each cookie that is passed to the handler routine. 4

9 ENVOY_AX_SEND_T Wind River SNMP can call this macro either before or after the handler function returns. cookie Specify the information block that you passed to the handler routine. error_stat If an error occurs, indicate the error condition as either AgentX session loss ENVOY_AX_SESS_LOSS or illegal operation ENVOY_AX_BAD_OPERATION. None. 1 SEE ALSO ENVOY_AX_ADD_T, ENVOY_AX_ADMIN_T, ENVOY_AX_SEND_T AgentX ENVOY_AX_SEND_T ENVOY_AX_SEND_T AgentX send handler int ENVOY_AX_SEND_T ptr_t cookie, ptr_t ax_pkt, ptr_t vblist, ALENGTH_T need This is a prototype for a routine that the handler calls to sends a response message. This routine should allocate enough space for the size specified in need, place that space into an EBUFFER_T structure, and call envoy_ax_pkt_encode to create the message. If the encoding is successful, the message should be sent to the destination indicated by cookie. You should pass all variables to the encode routine without changing them. Wind River SNMP can call this macro either before or after the handler function returns. ax_pkt Specify an AgentX packet. cookie Specify the information block that you passed to the handler routine. need Specify the length of the message in bytes. vblist Specify an extra list of VarBinds. This routine should return 0 if it is successful and 1 for failure. 5

10 Wind River SNMP API Reference, 10.2 SEE ALSO ENVOY_AX_ADD_T, ENVOY_AX_ADMIN_T, envoy_ax_chunk_handler, ENVOY_AX_ERROR_T,envoy_ax_pkt_encode ERR_COMPLETE_T ERR_COMPLETE_T error completion routine void ERR_COMPLETE_T SNMPADDR_T * for_addr, SNMPADDR_T * loc_addr, int error_code, PTR_T cookie This is a prototype for an error completion routine that allows you the opportunity to release any memory associated with this packet; for example addresses or the cookie. A routine of this type is passed to Process_Rcvd_SNMP_Packet_Async and SNMP_Send_Notify_Name. It is called when Wind River SNMP has finished processing a packet and there is no response packet. It can be called either before or after the main processing routine returns. NOTE: If this completion routine is called as a result of a call to SNMP_Send_Notify_Name, do not free the cookie. *for_addr Specify the destination of the packet. *loc_addr Specify the source of the packet. error_code Indicate what happened. 0 indicates that, even though we do not have a response packet, no errors have occurred. Responses from proxy targets can cause this condition. Non-zero indicates some sort of error, currently no specific errors are defined. cookie Can be used to pass information, for example, the packet s source address, to a completion or cleanup routine. It passes unchanged from the Process_Rcvd_SNMP_Packet_Async routine to the call to the completion routine. None. 6

11 IO_COMPLETE_T SEE ALSO IO_COMPLETE_T, Process_Rcvd_SNMP_Packet_Async, PROXY_ROUTINE_T, RETRANS_CLEANUP_T, SNMP_Send_Notify_Name, TRANSPORT_ROUTINE_T 1 IO_COMPLETE_T IO_COMPLETE_T I/O completion routine void IO_COMPLETE_T SNMPADDR_T * for_addr, SNMPADDR_T * loc_addr, PTR_T pktp, ALENGTH_T need, PTR_T cookie A routine of this type is passed to Process_Rcvd_SNMP_Packet_Async and SNMP_Send_Notify_Name. It is called when Wind River SNMP has finished processing a packet and there is a response packet. This routine can be called before or after the main processing routine returns. Generally, the completion routine attempts to send the packet to for_addr though you can determine the address by other methods. The completion routine should call SNMP_Process_Finish to encode the packet into a byte string. If you choose, the routine can allocate a buffer for SNMP_Process_Finish to use. You can also leave the buffer empty and let the encoding routines attempt to allocate space using the SNMP_memory_alloc or SNMP_memory_free routines. The routine should send the buffer and, if appropriate, free the buffer space. NOTE: If this completion routine is called as a result of a call to SNMP_Send_Notify_Name, do not free the cookie. *for_addr Specify the destination of the packet. *loc_addr Specify the source of the packet. *pktp Contain the address of the received packet buffer to encode and transmit. need Specify the length of the buffer needed to encode pktp. 7

12 Wind River SNMP API Reference, 10.2 cookie Can be used to pass information, for example, the packet s source address, to a completion or cleanup routine. The cookie argument is passed unchanged from the Process_Rcvd_SNMP_Packet_Async call to the completion routine. None. SEE ALSO ERR_COMPLETE_T, Process_Rcvd_SNMP_Packet_Async, PROXY_ROUTINE_T, RETRANS_CLEANUP_T, TRANSPORT_ROUTINE_T, SNMP_memory_alloc, SNMP_memory_free, SNMP_Process_Finish, SNMP_Send_Notify_Name AgentX PROXY_ROUTINE_T PROXY_ROUTINE_T translation routine for proxy packets INT_32_T PROXY_ROUTINE_T SNMP_PKT_T * pktp This is a prototype for a translation routine attached to the proxy_routine field in the SNMP_PKT_T structure. It should translate the packet from its current format to the format appropriate for the selected proxy target. Wind River SNMP-supplied conversion routines change the version number and community string. Use the standard encode routines to encode the packet. They will call the transport routine specified in the PROXY_BLOCK_T structure attached to the SNMP_PKT_T structure to send the packet over the selected transport layer. NOTE: This handler is used by the code installed through both the ENVOY_SNMP_PROXY and ENVOY_SNMP_PROXY_V3 options. The behavior of this routine is the same under both proxy regimes. This routine should return a value less than 0 for failure, or a time-out period in milliseconds for success. SEE ALSO ERR_COMPLETE_T, IO_COMPLETE_T, Process_Rcvd_SNMP_Packet_Async, RETRANS_CLEANUP_T, TRANSPORT_ROUTINE_T, SNMP_Send_Notify 8

13 RETRANS_CLEANUP_T SNMPv3 RETRANS_CLEANUP_T 1 RETRANS_CLEANUP_T notify retransmit cleanup completion routine void RETRANS_CLEANUP_T ptr_t cookie This is a prototype for a routine that is called when Wind River SNMP has finished processing a Notify or, as in the case of an Inform, the targets have either responded or completely timed out. When called, a routine of this type should dispose of the cookie by freeing any resources associated with it. cookie Can be used to pass information, for example, the packet s source address, to a completion or cleanup routine. It passes unchanged. None. SEE ALSO ERR_COMPLETE_T, IO_COMPLETE_T, Process_Rcvd_SNMP_Packet_Async, PROXY_ROUTINE_T, TRANSPORT_ROUTINE_T, SNMP_Send_Notify TRANSPORT_ROUTINE_T TRANSPORT_ROUTINE_T transport routine for proxy packets INT_32_T TRANSPORT_ROUTINE_T EBUFFER_T * ebuffp, PTR_T cookie This is a prototype for the transport or send routine attached to the PROXY_BLOCK_T structure. Use this handler to send proxy packets. Attach any addressing information for this handler to the transport_block field of the PROXY_BLOCK_T structure that is passed to the send routine as the cookie argument. This routine should transmit the buffer from ebuffp to the specified address. NOTE: This handler is available for use when you install the ENVOY_SNMP_PROXY option. cookie Can be used to pass information, for example, the packet s source address, to a completion or cleanup routine. It passes unchanged. 9

14 Wind River SNMP API Reference, 10.2 *ebuffp Point to the buffer. If successful, this routine returns the value of eflag, the time-out period which specifies how long the transport routine should wait before returning. In this case, 0 is a valid response. However, any value less than 0 indicates failure. SEE ALSO ERR_COMPLETE_T, IO_COMPLETE_T, Process_Rcvd_SNMP_Packet_Async, PROXY_ROUTINE_T SNMPv3 ENVOY_ADD_ENGINE_ADDRESS ENVOY_ADD_ENGINE_ADDRESS add an engine ID to the engine table int ENVOY_ADD_ENGINE_ADDRESS SNMP_PKT_T * rp, SNMPADDR_T * address, int create This user-exit adds the engine ID to the engine table. It converts the SNMPADDR_T to a TDomain and TAddress pair and calls SNMP_Engine_Set_Address to add it to the engine. This is a function that customers must write. This default Wind River SNMP implementation of this function is available only when the ENVOY_SNMP_V3_TARGET installation option is installed. If you haven t installed ENVOY_SNMP_V3_TARGET, the default is to define it to ENVOY_ADD_ENGINE_ID. If you write your own version, your version will override the default Wind River SNMP implementation. *rp Point to the packet. *address Point to the engine s address. create If this value is 0, create the engine leaf. If this value is 1, just associate the address with an existing engine. If successful, this routine returns 1. Otherwise, it returns 0. 10

15 ENVOY_ADD_ENGINE_ID SEE ALSO ENVOY_TADDRESS_TO_SNMPADDR, ENVOY_SET_RETRANS_ID, ENVOY_SNMPADDR_TO_TADDRESS, ENVOY_ADD_ENGINE_ID, SNMP_Engine_Set_Address 1 SNMPv3 ENVOY_ADD_ENGINE_ID ENVOY_ADD_ENGINE_ID add an engine ID to the engine table void ENVOY_ADD_ENGINE_ID SNMP_PKT_T * pkt If this user-exit is defined, when Wind River SNMP encounters an unknown engine ID while processing a packet, it calls ENVOY_ADD_ENGINE_ID to discover the given engine. It adds the engine ID of the new engine found in the msg_sec_id field of pkt to the engine table. This user-exit is maintained for backward compatibility. Use ENVOY_ADD_ENGINE_ADDRESS instead. *pkt Point to the SMNP packet. None. SEE ALSO ENVOY_TADDRESS_TO_SNMPADDR, ENVOY_SET_RETRANS_ID, ENVOY_SNMPADDR_TO_TADDRESS, ENVOY_ADD_ENGINE_ADDRESS, SNMP_Engine_Set_Address AgentX ENVOY_AX_CONN_ENTRY ENVOY_AX_CONN_ENTRY return the time, domain and addr for a specified connid bits32_t ENVOY_AX_CONN_ENTRY bits32_t axconnid, int matchflag, AX_CONNENT_T * pconnentry This user-exit returns a pointer to a specific connection entry via the AX_CONNENT_T connection entry structure. This structure contains the time that the connection was established in the field agentxconnopentime, the transport protocol used by the 11

16 Wind River SNMP API Reference, 10.2 connection in the field agentxconntransportdomain, and the transport address of the remote subagent in the field agentxconntransportaddress. axconnid Specify the connection identifier. matchflag Specify whether the caller is looking for an exact match AX_MATCH_GET or wants the lexicographic next object AX_MATCH_NEXT. pconnentry Specify a pointer to a connection entry structure supplied by the caller, and filled in if the connection entry is found. If successful, this routine returns 1. Otherwise, it returns 0. SEE ALSO ENVOY_AX_GET_CONNID AgentX ENVOY_AX_COOKIE_CMP ENVOY_AX_COOKIE_CMP compare two AgentX information blocks int ENVOY_AX_COOKIE_CMP ptr_t cookie_1, ptr_t cookie_2 This is a prototype for a handler that compares two information blocks passed to the handler. Wind River SNMP contains a default version of this macro, which performs a simple test. If you define your own version, it will be used. cookie_1 Specify the first information block that was passed to the handler routine. cookie_2 Specify the second information block that was passed to the handler routine. This handler should return 1 for when the blocks are good and 0 for if not. SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_MA_AC_ADD, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_MA_AC_REMOVE, ENVOY_AX_TRANSLATE_CONTEXT, ENVOY_AX_SA_MIB_ROOT_NODE 12

17 ENVOY_AX_FIND_MIB AgentX ENVOY_AX_FIND_MIB 1 ENVOY_AX_FIND_MIB find a MIB to use with a given context MIBNODE_T * ENVOY_AX_FIND_MIB EBUFFER_T * context This is a prototype for a routine the master agent calls to receive the context information from a subagent request message. *context Specify the context string. If the context is a valid context name, this routine should return the root of the MIB tree for that context. Otherwise, it should return 0. SEE ALSO ENVOY_AX_MA_AC_ADD, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_MA_AC_REMOVE, ENVOY_AX_TRANSLATE_CONTEXT, ENVOY_AX_SA_MIB_ROOT_NODE AgentX ENVOY_AX_GET_CONNID ENVOY_AX_GET_CONNID return the connection ID for a specific session bits32_t ENVOY_AX_GET_CONNID ptr_t * cookie This user-exit returns the connection ID associated with a specific session ID. cookie A pointer to the send_cookie. The x function can use this cookie to retrieve connection information. If successful, this routine returns a Connection ID. Otherwise, it returns 0. SEE ALSO ENVOY_AX_CONN_ENTRY 13

18 Wind River SNMP API Reference, 10.2 AgentX ENVOY_AX_MA_AC_ADD ENVOY_AX_MA_AC_ADD register a VarBindList in the agent capabilities table bits16_t ENVOY_AX_MA_AC_ADD ENVOY_AX_PKT_T * ax_pkt, MIBNODE_T * mibroot This is a prototype for a routine the master agent calls to register the VarBindList contained in ax_pkt in its agent capabilities table. This function should update the agent-capability information in the sysuptable if supported. *ax_pkt Specify an AgentX packet structure. *mibroot Specify the root of the MIB tree that was identified by ENVOY_AX_FIND_MIB. If successful, this routine should return 0. Otherwise, it should set the return code to the error status for the response message as defined by the AgentX specification. SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_MA_AC_REMOVE, ENVOY_AX_TRANSLATE_CONTEXT, ENVOY_AX_SA_MIB_ROOT_NODE AgentX ENVOY_AX_MA_AC_CLEAN ENVOY_AX_MA_AC_CLEAN request subagent to remove session from agent table void ENVOY_AX_MA_AC_CLEAN bits32_t session_id This is a prototype for a routine the master agent calls to request a subagent to remove any agent capabilities the subagent has registered for a session. The master agent calls this routine when it attempts to close a session and clean up any resources associated with the session. session_id Specify a session. None. 14

19 ENVOY_AX_MA_AC_REMOVE SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_COOKIE_CMP, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_REMOVE, ENVOY_AX_TRANSLATE_CONTEXT, ENVOY_AX_SA_MIB_ROOT_NODE 1 AgentX ENVOY_AX_MA_AC_REMOVE ENVOY_AX_MA_AC_REMOVE request subagent to remove VarBindList from agent table bits16_t ENVOY_AX_MA_AC_REMOVE ENVOY_AX_PKT_T * ax_pkt, MIBNODE_T * mibroot This is a prototype for a routine the master agent calls to request a subagent to remove a VarBindList from its agent capabilities table. *ax_pkt Specify an AgentX packet structure. *mibroot Specify the root of the MIB tree that was identified by ENVOY_AX_FIND_MIB. If successful, this routine should return 0. Otherwise, it should set the return code to the error status for the response message as defined by the AgentX specification. SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_COOKIE_CMP, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_TRANSLATE_CONTEXT, ENVOY_AX_SA_MIB_ROOT_NODE AgentX ENVOY_AX_TRANSLATE_CONTEXT ENVOY_AX_TRANSLATE_CONTEXT extract context information from SNMP_PKT_T void ENVOY_AX_TRANSLATE_CONTEXT SNMP_PKT_T *, ENVOY_AX_PKT_T * 15

20 Wind River SNMP API Reference, 10.2 This is a prototype for a routine the master agent calls to extract the context and community information from an SNMP_PKT_T structure and place it into an AgentX request. This allows you to convert an SNMP context to an AgentX context, which isn t explicitly handled in the standards. Point to the SNMP packet structure from that is source of the context information. Point to the AgentX packet structure that is the target for the context information. None. SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_COOKIE_CMP, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_MA_AC_REMOVE, ENVOY_AX_SA_MIB_ROOT_NODE AgentX ENVOY_AX_SA_MIB_ROOT_NODE ENVOY_AX_SA_MIB_ROOT_NODE determine the appropriate MIB tree int ENVOY_AX_SA_MIB_ROOT_NODE ptr_t cookie, SNMP_PKT_T * pktp This is a prototype for a routine the subagent calls to determine which MIB tree to install in the SNMP packet structure. cookie Specify the cookie that was passed to the subagent handler routine. *pktp Specify an AgentX packet. If this routine is successful, it should return 0. Otherwise, it should return any other value. SEE ALSO ENVOY_AX_FIND_MIB, ENVOY_AX_COOKIE_CMP, ENVOY_AX_COOKIE_CMP, ENVOY_AX_MA_AC_CLEAN, ENVOY_AX_MA_AC_REMOVE, envoy_ax_sa_state_create, envoy_ax_sa_handler, envoy_ax_sa_state_init, envoy_ax_sa_session_loss 16

21 ENVOY_GET_SYSUPTIME AgentX ENVOY_GET_SYSUPTIME 1 ENVOY_GET_SYSUPTIME return the value for the sysuptime object bits32_t ENVOY_GET_SYSUPTIME EBUFFER_T * context This is a prototype for a routine the master agent calls to determine the value for the sysuptime object for the specified context. *context Specify the context string. If successful, this routine should return the value for the sysuptime object for the specified context. Otherwise, it should return 0. SEE ALSO ENVOY_NOW SNMPv3 ENVOY_SET_RETRANS_ID ENVOY_SET_RETRANS_ID customize outgoing notify numbering scheme void ENVOY_SET_RETRANS_ID SNMP_RETRANS_T * retrans This user-exit chooses the request ID and message ID of outgoing notifies, allowing you to use your own numbering scheme for notifies. By default, notify request IDs are integer values that start from 0 and increase monotonically. If you would like to write your own version, see the default implementation in the file target/h/wrn/wm/snmp/engine/sendntfy.h. *retrans Specify the RETRANS_BLOCK_T that needs a new request id. None. SEE ALSO ENVOY_TADDRESS_TO_SNMPADDR, ENVOY_SNMPADDR_TO_TADDRESS, ENVOY_ADD_ENGINE_ADDRESS, ENVOY_ADD_ENGINE_ID, SNMP Notify Commands 17

22 Wind River SNMP API Reference, 10.2 SNMPv3 ENVOY_SNMPADDR_TO_TADDRESS ENVOY_SNMPADDR_TO_TADDRESS convert SNMPADDR_T into TAddress and TDomain pair int ENVOY_SNMPADDR_TO_TADDRESS SNMPADDR_T * addr, OBJ_ID_T * tdomain, EBUFFER_T * taddress This user-exit converts an SNMPADDR_T structure into a TAddress and TDomain pair. NOTE: Wind River SNMP supplies a default version of this routine. If you write your own version, your version will override the default Wind River SNMP version. *addr Specify the address of the SNMPADDR_T structure. *tdomain Specify the TDomain. The format of the TAddress depends on the value of the corresponding instance of TDomain, which is defined in RFC *taddress Specify the TAddress. If successful, this routine returns 0. Otherwise, it returns -1. SEE ALSO ENVOY_TADDRESS_TO_SNMPADDR, ENVOY_SET_RETRANS_ID, ENVOY_ADD_ENGINE_ADDRESS, ENVOY_ADD_ENGINE_ID, SNMPv3 ENVOY_TADDRESS_TO_SNMPADDR ENVOY_TADDRESS_TO_SNMPADDR convert a TAddress to an SNMPADDR_T int ENVOY_TADDRESS_TO_SNMPADDR SNMPADDR_T * addr, OBJ_ID_T * tdomain, EBUFFER_T * taddress This user-exit converts a TAddress and TDomain pair into an SNMPADDR_T structure. 18

23 SNMP_DH_RAND NOTE: Wind River SNMP supplies a default version of this routine. If you write your own version, your version will override the default Wind River SNMP version. 1 *addr Specify the address of the SNMPADDR_T structure. *tdomain Specify the TDomain. The format of the TAddress depends on the value of the corresponding instance of TDomain, which is defined in RFC *taddress Specify the TAddress. If successful, this routine returns 0. Otherwise, it returns -1. SEE ALSO ENVOY_SET_RETRANS_ID, ENVOY_SNMPADDR_TO_TADDRESS, ENVOY_ADD_ENGINE_ADDRESS, ENVOY_ADD_ENGINE_ID SNMP_DH_RAND SNMP_DH_RAND set the pseudo-random number generator seed void SNMP_DH_RAND const void * seedbuff, int buffsize This user-exit sets the pseudo-random number generator PRNG seed, which is mixed with the existing PRNG state. You must call the user-exit with no less than 128 bits of random data prior to using any of the OpenSSL crypto or Wind River Common Crypto Interface CCI Diffie-Hellman routines. *seedbuff A pointer to a series of bytes. buffsize The size of the buffer. None. SEE ALSO SNMP_DH_decodeParams, SNMP_DH_encodeParams, SNMP_get_DH_params, SNMP_set_DH_params 19

24 Wind River SNMP API Reference, 10.2 SNMP_user_get_encode_buffer SNMP_user_get_encode_buffer allocate memory for an encoded packet int SNMP_user_get_encode_buffer SNMP_PKT_T * pktp, unsigned int need, EBUFFER_T * ebuffp If this user-exit is defined, you can call it to allocate memory to encode the contents of an SNMP packet. *pktp Specify the packet. need Indicate how many bytes are required in the encode buffer. *ebuffp Point to an EBUFFER_T structure to be used to define the buffer in which the resulting PDU, if any, is to be placed. There are three possible actions you can take when this user-exit is called: Return 0 and leave ebuffp unmodified. This is effectively a no-op because Wind River SNMP will allocate the memory later. Return 0 and set ebuffp to point to an appropriately-sized buffer. Return 1 to indicate that an error occurred. This causes Wind River SNMP to abort the encode procedure and no packet will be sent. SEE ALSO EbufferAllocateLoad, EbufferPreLoad, SNMP_Encode_Packet SNMPv3 SNMP V3 TEST Macros SNMP V3 TEST Macros reserve resources requested for a SET operation Whenever a SET REQUEST creates, modifies updates or deletes destroys a table entry, one of the following TEST macros is called. The underlying routine must reserve any resources that the SET operation requires unless the entry is deleted. 20

25 SNMP V3 TEST Macros Method routines that call CREATE TEST macros must supply a pointer to the structure to be installed in the database. During normal processing, the value of some fields can change. Undo these changes before the structure is installed in the database. 1 *current Specify this entry s current information and indices for DESTROY TEST and UPDATE TEST macros. If this is a new entry, this value is 0. *new Specify the new information to install or 0 for existing entries. If current is 0, CREATE TEST and UPDATE TEST macros also include indexing information. *pkt Specify the packet that is requesting the SET operation. *vbp Specify the VarBind that caused the method routine to run. If the TEST operation was successful and processing should continue, TEST macros return the value NO_ERROR as defined in h/snmpdefs.h. Any other return is considered a failure and is used as the error argument to testproc_error. If the TEST operation succeeds, set the BACKOUT routine to be called by the vb_free_priv routine. PROTOTYPES SNMP_V3_ACCESS_DESTROY_TEST sbits32_t SNMP_V3_ACCESS_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_CREATE_TEST sbits32_t SNMP_V3_ACCESS_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_UPDATE_TEST sbits32_t SNMP_V3_ACCESS_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new 21

26 Wind River SNMP API Reference, 10.2 SNMP_V3_COMM_DESTROY_TEST sbits32_t SNMP_V3_COMM_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_CREATE_TEST sbits32_t SNMP_V3_COMM_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_UPDATE_TEST sbits32_t SNMP_V3_COMM_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_GROUP_DESTROY_TEST sbits32_t SNMP_V3_GROUP_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_CREATE_TEST sbits32_t SNMP_V3_GROUP_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_UPDATE_TEST sbits32_t SNMP_V3_GROUP_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new 22

27 SNMP V3 TEST Macros SNMP_V3_NOTIFY_DESTROY_TEST sbits32_t SNMP_V3_NOTIFY_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_CREATE_TEST sbits32_t SNMP_V3_NOTIFY_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_UPDATE_TEST sbits32_t SNMP_V3_NOTIFY_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new 1 SNMP_V3_NFILT_DESTROY_TEST sbits32_t SNMP_V3_NFILT_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_CREATE_TEST sbits32_t SNMP_V3_NFILT_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_UPDATE_TEST sbits32_t SNMP_V3_NFILT_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new 23

28 Wind River SNMP API Reference, 10.2 SNMP_V3_NPROF_DESTROY_TEST sbits32_t SNMP_V3_NPROF_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_NPROF_CREATE_TEST sbits32_t SNMP_V3_NPROF_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_NPROF_UPDATE_TEST sbits32_t SNMP_V3_NPROF_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_PROXY_DESTROY_TEST sbits32_t SNMP_V3_PROXY_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_CREATE_TEST sbits32_t SNMP_V3_PROXY_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_UPDATE_TEST sbits32_t SNMP_V3_PROXY_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new 24

29 SNMP V3 TEST Macros SNMP_V3_TADDR_DESTROY_TEST sbits32_t SNMP_V3_TADDR_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_CREATE_TEST sbits32_t SNMP_V3_TADDR_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_UPDATE_TEST sbits32_t SNMP_V3_TADDR_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TPARAM_DESTROY_TEST sbits32_t SNMP_V3_TPARAM_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_TPARAM_CREATE_TEST sbits32_t SNMP_V3_TPARAM_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_TPARAM_UPDATE_TEST sbits32_t SNMP_V3_TPARAM_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new 1 25

30 Wind River SNMP API Reference, 10.2 SNMP_V3_USER_DESTROY_TEST sbits32_t SNMP_V3_USER_DESTROY_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_CREATE_TEST sbits32_t SNMP_V3_USER_CREATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_UPDATE_TEST sbits32_t SNMP_V3_USER_UPDATE_TEST SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new SNMPv3 SNMP V3 BACKOUT Macros SNMP V3 BACKOUT Macros free pre-staged information and resources from a failed TEST When a TEST macro succeeds, Wind River SNMP sets up the BACKOUT macro to allow pre-staged info to be released in the case of a later failure. *current Specify this entry s current information and indices for DESTROY TEST and UPDATE TEST macros. If this is a new entry, this value is 0. *new Specify the new information to install, or 0 for existing entries. This value is set for CREATE and UPDATE calls. If current is 0, CREATE and UPDATE macros also include indexing information. None. 26

31 SNMP V3 BACKOUT Macros PROTOTYPES SNMP_V3_ACCESS_DESTROY_BACKOUT void SNMP_V3_ACCESS_DESTROY_BACKOUT SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_CREATE_BACKOUT void SNMP_V3_ACCESS_CREATE_BACKOUT SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_UPDATE_BACKOUT void SNMP_V3_ACCESS_UPDATE_BACKOUT SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_COMM_DESTROY_BACKOUT void SNMP_V3_COMM_DESTROY_BACKOUT SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_CREATE_BACKOUT void SNMP_V3_COMM_CREATE_BACKOUT SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_UPDATE_BACKOUT void SNMP_V3_COMM_UPDATE_BACKOUT SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_GROUP_DESTROY_BACKOUT void SNMP_V3_GROUP_DESTROY_BACKOUT SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_CREATE_BACKOUT void SNMP_V3_GROUP_CREATE_BACKOUT SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_UPDATE_BACKOUT void SNMP_V3_GROUP_UPDATE_BACKOUT SNMP_GROUP_T * current, SNMP_GROUP_T * new 1 27

32 Wind River SNMP API Reference, 10.2 SNMP_V3_NOTIFY_DESTROY_BACKOUT void SNMP_V3_NOTIFY_DESTROY_BACKOUT SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_CREATE_BACKOUT void SNMP_V3_NOTIFY_CREATE_BACKOUT SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_UPDATE_BACKOUT void SNMP_V3_NOTIFY_UPDATE_BACKOUT SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NFILT_DESTROY_BACKOUT void SNMP_V3_NFILT_DESTROY_BACKOUT SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_CREATE_BACKOUT void SNMP_V3_NFILT_CREATE_BACKOUT SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_UPDATE_BACKOUT void SNMP_V3_NFILT_UPDATE_BACKOUT SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NPROF_DESTROY_BACKOUT void SNMP_V3_NPROF_DESTROY_BACKOUT SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_NPROF_CREATE_BACKOUT void SNMP_V3_NPROF_CREATE_BACKOUT SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new 28

33 SNMP V3 BACKOUT Macros SNMP_V3_NPROF_UPDATE_BACKOUT void SNMP_V3_NPROF_UPDATE_BACKOUT SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_PROXY_DESTROY_BACKOUT void SNMP_V3_PROXY_DESTROY_BACKOUT SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_CREATE_BACKOUT void SNMP_V3_PROXY_CREATE_BACKOUT SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_UPDATE_BACKOUT void SNMP_V3_PROXY_UPDATE_BACKOUT SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_TADDR_DESTROY_BACKOUT void SNMP_V3_TADDR_DESTROY_BACKOUT SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_CREATE_BACKOUT void SNMP_V3_TADDR_CREATE_BACKOUT SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_UPDATE_BACKOUT void SNMP_V3_TADDR_UPDATE_BACKOUT SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TPARAM_DESTROY_BACKOUT void SNMP_V3_TPARAM_DESTROY_BACKOUT SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_TPARAM_CREATE_BACKOUT void SNMP_V3_TPARAM_CREATE_BACKOUT SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new 1 29

34 Wind River SNMP API Reference, 10.2 SNMP_V3_TPARAM_UPDATE_BACKOUT void SNMP_V3_TPARAM_UPDATE_BACKOUT SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_USER_DESTROY_BACKOUT void SNMP_V3_USER_DESTROY_BACKOUT SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_CREATE_BACKOUT void SNMP_V3_USER_CREATE_BACKOUT SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_UPDATE_BACKOUT void SNMP_V3_USER_UPDATE_BACKOUT SNMP_USER_T * current, SNMP_USER_T * new SNMPv3 SNMP V3 SET Macros SNMP V3 SET Macros create, change, or delete a table entry After a method routine has successfully called a TEST macro to reserve resources and pre validated your SET REQUEST, the setproc calls the corresponding SET macro to create, change, or delete the table entry. *new Specify the new information to install, or 0 for existing entries. This value is set for CREATE and UPDATE calls. If current is 0, CREATE and UPDATE macros also include indexing information. *current Specify this entry s previous information and indices.this value is set for DESTROY and UPDATE calls. If this is a new entry, this value is 0. *pkt Specify the packet that is requesting the SET operation. *vbp Specify the VarBind that caused the method routine to run. 30

35 SNMP V3 SET Macros If the SET REQUEST is successful and the SET macro returns 0, method routines should set the corresponding FINISHED macro to be called in the vb_free_priv routine, and then set the undoproc. 1 PROTOTYPES SNMP_V3_ACCESS_DESTROY_SET void SNMP_V3_ACCESS_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_CREATE_SET void SNMP_V3_ACCESS_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_ACCESS_UPDATE_SET void SNMP_V3_ACCESS_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * new SNMP_V3_COMM_DESTROY_SET void SNMP_V3_COMM_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_CREATE_SET void SNMP_V3_COMM_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new SNMP_V3_COMM_UPDATE_SET void SNMP_V3_COMM_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * new 31

36 Wind River SNMP API Reference, 10.2 SNMP_V3_GROUP_DESTROY_SET void SNMP_V3_GROUP_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_CREATE_SET void SNMP_V3_GROUP_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_GROUP_UPDATE_SET void SNMP_V3_GROUP_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * new SNMP_V3_NOTIFY_DESTROY_SET void SNMP_V3_NOTIFY_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_CREATE_SET void SNMP_V3_NOTIFY_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new SNMP_V3_NOTIFY_UPDATE_SET void SNMP_V3_NOTIFY_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * new 32

37 SNMP V3 SET Macros SNMP_V3_NFILT_DESTROY_SET void SNMP_V3_NFILT_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_CREATE_SET void SNMP_V3_NFILT_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NFILT_UPDATE_SET void SNMP_V3_NFILT_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * new SNMP_V3_NPROF_DESTROY_SET void SNMP_V3_NPROF_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_NPROF_CREATE_SET void SNMP_V3_NPROF_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new SNMP_V3_NPROF_UPDATE_SET void SNMP_V3_NPROF_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * new 1 33

38 Wind River SNMP API Reference, 10.2 SNMP_V3_PROXY_DESTROY_SET void SNMP_V3_PROXY_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_CREATE_SET void SNMP_V3_PROXY_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_PROXY_UPDATE_SET void SNMP_V3_PROXY_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * new SNMP_V3_TADDR_DESTROY_SET void SNMP_V3_TADDR_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_CREATE_SET void SNMP_V3_TADDR_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new SNMP_V3_TADDR_UPDATE_SET void SNMP_V3_TADDR_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * new 34

39 SNMP V3 SET Macros SNMP_V3_TPARAM_DESTROY_SET void SNMP_V3_TPARAM_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_TPARAM_CREATE_SET void SNMP_V3_TPARAM_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_TPARAM_UPDATE_SET void SNMP_V3_TPARAM_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_T * current, SNMP_TARGET_PARAMS_T * new SNMP_V3_USER_DESTROY_SET void SNMP_V3_USER_DESTROY_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_CREATE_SET void SNMP_V3_USER_CREATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new SNMP_V3_USER_UPDATE_SET void SNMP_V3_USER_UPDATE_SET SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * new 1 35

40 Wind River SNMP API Reference, 10.2 SNMPv3 SNMP V3 UNDO Macros SNMP V3 UNDO Macros undo a SET error When Wind River SNMP calls a setproc, and the SET macro has completed, method routines should set the undoproc and set the FINISHED macro to be called in the vb_free_priv routine. *current Specify this entry s newly installed information and indices. This value is set for CREATE and UPDATE calls. If this is a new entry, this value is 0. *pkt Specify the packet that is requesting the SET operation. *save Specify this entry s previous information and indices to restore. This value is set for DESTROY and UPDATE calls. When the value of current is 0, save includes indexing information. If this is a new entry, this value is 0. *vbp Specify the VarBind that caused the method routine to run. If the restore operation is successful, UNDO macros return 0. Otherwise, they return -1. PROTOTYPES SNMP_V3_ACCESS_DESTROY_UNDO int SNMP_V3_ACCESS_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * save SNMP_V3_ACCESS_CREATE_UNDO int SNMP_V3_ACCESS_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * save SNMP_V3_ACCESS_UPDATE_UNDO int SNMP_V3_ACCESS_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_ACCESS_T * current, SNMP_ACCESS_T * save 36

41 SNMP V3 UNDO Macros SNMP_V3_COMM_DESTROY_UNDO int SNMP_V3_COMM_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * save SNMP_V3_COMM_CREATE_UNDO int SNMP_V3_COMM_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * save SNMP_V3_COMM_UPDATE_UNDO int SNMP_V3_COMM_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_COMMUNITY_T * current, SNMP_COMMUNITY_T * save SNMP_V3_GROUP_DESTROY_UNDO int SNMP_V3_GROUP_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * save SNMP_V3_GROUP_CREATE_UNDO int SNMP_V3_GROUP_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * save SNMP_V3_GROUP_UPDATE_UNDO int SNMP_V3_GROUP_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_GROUP_T * current, SNMP_GROUP_T * save 1 37

42 Wind River SNMP API Reference, 10.2 SNMP_V3_NOTIFY_DESTROY_UNDO int SNMP_V3_NOTIFY_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * save SNMP_V3_NOTIFY_CREATE_UNDO int SNMP_V3_NOTIFY_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * save SNMP_V3_NOTIFY_UPDATE_UNDO int SNMP_V3_NOTIFY_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_T * current, SNMP_NOTIFY_T * save SNMP_V3_NFILT_DESTROY_UNDO int SNMP_V3_NFILT_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * save SNMP_V3_NFILT_CREATE_UNDO int SNMP_V3_NFILT_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * save SNMP_V3_NFILT_UPDATE_UNDO int SNMP_V3_NFILT_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_T * current, SNMP_NOTIFY_FILTER_T * save 38

43 SNMP V3 UNDO Macros SNMP_V3_NPROF_DESTROY_UNDO int SNMP_V3_NPROF_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * save SNMP_V3_NPROF_CREATE_UNDO int SNMP_V3_NPROF_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * save SNMP_V3_NPROF_UPDATE_UNDO int SNMP_V3_NPROF_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_NOTIFY_FILTER_PROFILE_T * current, SNMP_NOTIFY_FILTER_PROFILE_T * save SNMP_V3_PROXY_DESTROY_UNDO int SNMP_V3_PROXY_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * save SNMP_V3_PROXY_CREATE_UNDO int SNMP_V3_PROXY_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * save SNMP_V3_PROXY_UPDATE_UNDO int SNMP_V3_PROXY_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_PROXY_T * current, SNMP_PROXY_T * save 1 39

44 Wind River SNMP API Reference, 10.2 SNMP_V3_TADDR_DESTROY_UNDO int SNMP_V3_TADDR_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * save SNMP_V3_TADDR_CREATE_UNDO int SNMP_V3_TADDR_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * save SNMP_V3_TADDR_UPDATE_UNDO int SNMP_V3_TADDR_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_ADDR_T * current, SNMP_TARGET_ADDR_T * save SNMP_V3_TPARAM_PROFILE_DESTROY_UNDO int SNMP_V3_TPARAM_PROFILE_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_PROFILE_T * current, SNMP_TARGET_PARAMS_PROFILE_T * save SNMP_V3_TPARAM_PROFILE_CREATE_UNDO int SNMP_V3_TPARAM_PROFILE_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_PROFILE_T * current, SNMP_TARGET_PARAMS_PROFILE_T * save SNMP_V3_TPARAM_PROFILEUPDATE_UNDO int SNMP_V3_TPARAM_PROFILEUPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_TARGET_PARAMS_PROFILE_T * current, SNMP_TARGET_PARAMS_PROFILE_T * save 40

45 SNMP V3 FINISHED Macros SNMP_V3_USER_DESTROY_UNDO int SNMP_V3_USER_DESTROY_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * save SNMP_V3_USER_CREATE_UNDO int SNMP_V3_USER_CREATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * save SNMP_V3_USER_UPDATE_UNDO int SNMP_V3_USER_UPDATE_UNDO SNMP_PKT_T * pkt, VB_T * vbp, SNMP_USER_T * current, SNMP_USER_T * save 1 SNMPv3 SNMP V3 FINISHED Macros SNMP V3 FINISHED Macros free a packet structure and resources after a SET REQUEST When a SET REQUEST is successful, method routines should set the corresponding FINISHED macro to be called as part of the clean up process using the vb_free_priv routine. None. PROTOTYPES SNMP_V3_ACCESS_FINISHED void SNMP_V3_ACCESS_FINISHED SNMP_V3_COMM_FINISHED void SNMP_V3_COMM_FINISHED SNMP_V3_GROUP_FINISHED void SNMP_V3_GROUP_FINISHED SNMP_V3_NOTIFY_FINISHED void SNMP_V3_NOTIFY_FINISHED 41

46 Wind River SNMP API Reference, 10.2 SNMP_V3_NFILT_FINISHED void SNMP_V3_NFILT_FINISHED SNMP_V3_NPROF_FINISHED void SNMP_V3_NPROF_FINISHED SNMP_V3_PROXY_FINISHED void SNMP_V3_PROXY_FINISHED SNMP_V3_TADDR_FINISHED void SNMP_V3_TADDR_FINISHED SNMP_V3_TPARAM_FINISHED void SNMP_V3_TPARAM_FINISHED SNMP_V3_USER_FINISHED void SNMP_V3_USER_FINISHED RFC2275 View Method Routine Macros RFC2275 View Method Routine Macros service the RFC2275 view table These macros allow you to service the RFC2275 view table VacmViewTreeFamilyTable. They are the interface between the method routines and any nonvolatile storage code that you supply. Specifically, method routines must call these macros to implement RFC2275 view SET REQUESTs for the RFC2275 view table MIB objects. If you want to use nonvolatile storage for any of these tables, you need to define these macros. If they are defined, Wind River SNMP s method routines will call them. If you do not use nonvolatile storage, you do not need to define these macros. You can also use these macros to implement policies for creation, modification, or deletion of table entries. Use the following procedure to make a multi-stage RFC2275 view SET REQUEST: 1. The method routine calls a RFC2275 view TEST macro to collect information, reserve resources, and pre validate your RFC2275 view SET REQUEST. 2. If the RFC2275 view testproc is successful, set the corresponding BACKOUT macro to allow pre-staged info to be released in the case of a later failure. 3. If the RFC2275 view setproc is successful, you should set the corresponding RFC2275 view FINISHED macro to be set in the vb_free_priv routine, and then set therfc2275 view undoproc. If the RFC2275 view SET REQUEST fails, do not call the UNDO macro. 42