Jump to main content

##

# 1.2.1.19.3 Library Interface

Name | Description
--- | ---
Macros |
TCPIP_SNMP_BIB_FILE_NAME | The Microchip mib2bib.jar compiler is used to convert the Microchip MIB script to binary format and it is compatible with the Microchip SNMP agent. which is written in ASCII format. Name of the bib file for SNMP is snmp.bib.
TCPIP_SNMP_COMMUNITY_MAX_LEN | This is the maximum length for community string. Application must ensure that this length is observed. SNMP module adds one byte extra after TCPIP_SNMP_COMMUNITY_MAX_LEN for adding '0' NULL character.
TCPIP_SNMP_MAX_COMMUNITY_SUPPORT | Specifying more strings than TCPIP_SNMP_MAX_COMMUNITY_SUPPORT will result in the later strings being ignored (but still wasting program memory). Specifying fewer strings is legal, as long as at least one is present.
TCPIP_SNMP_MAX_MSG_SIZE | The maximum length in octets of an SNMP message which this SNMP agent able to process. As per RFC 3411 snmpEngineMaxMessageSize and RFC 1157 ( section 4- protocol specification ) and implementation supports more than 480 whenever feasible. It should be divisible by 16
TCPIP_SNMP_MAX_NON_REC_ID_OID | Update the Non record id OID value which is part of CustomSnmpDemoApp.c file. This is the maximum size for gSnmpNonMibRecInfo which is the list of static variable Parent OIDs which are not part of mib.h file. This structure is used to restrict access to static variables of SNMPv3 OIDs from SNMPv2c and SNMPv1 version. With SNMPv3 all the OIDs accessible but when we are using SNMPv2c version , static variables of the SNMPv3 cannot be accessible with SNMP version v2c. SNMP agent supports both SMIv1 and SMIv2 standard and snmp.mib has been updated with respect to SMIV2 standard and it... more
TCPIP_SNMP_NOTIFY_COMMUNITY_LEN | Maximum length for SNMP Trap community name
TCPIP_SNMP_OID_MAX_LEN | Maximum length for the OID String. Change this to match your OID string length.
TCPIP_SNMP_TASK_PROCESS_RATE | SNMP task processing rate, in milli-seconds. The SNMP module will process a timer event with this rate for processing its own state machine, etc. The default value is 200 milliseconds. The lower the rate (higher the frequency) the higher the module priority and higher module performance can be obtained The value cannot be lower than the TCPIP_STACK_TICK_RATE.
TCPIP_SNMP_TRAP_COMMUNITY_MAX_LEN | The maximum size of TRAP community string length
TCPIP_SNMP_TRAP_COMMUNITY_MAX_LEN_MEM_USE | Trap information. This macro will be used to avoid SNMP OID memory buffer corruption
TCPIP_SNMP_TRAP_TABLE_SIZE | This table maintains list of interested receivers who should receive notifications when some interesting event occurs.
TCPIP_SNMPV3_AUTH_LOCALIZED_PASSWORD_KEY_LEN | SNMPv3 Authentication Localized password key length size
TCPIP_SNMPV3_AUTH_LOCALIZED_PASSWORD_KEY_LEN_MEM_USE | SNMPv3 authentication localized Key length for memory validation
TCPIP_SNMPV3_PRIV_LOCALIZED_PASSWORD_KEY_LEN | SNMPv3 Privacy Password key length size
TCPIP_SNMPV3_PRIV_LOCALIZED_PASSWORD_KEY_LEN_MEM_USE | SNMPv3 privacy key length size for memory validation
TCPIP_SNMPV3_USER_SECURITY_NAME_LEN | Maximum size for SNMPv3 User Security Name length.
TCPIP_SNMPV3_USER_SECURITY_NAME_LEN_MEM_USE | User security name length for memory validation
TCPIP_SNMPV3_USM_MAX_USER | Maximum number of SNMPv3 users. User Security Model should have at least 1 user. Default is 3.
**SNMP Module Functions ** |
TCPIP_SNMP_NotifyIsReady | Resolves given remoteHost IP address into MAC address.
TCPIP_SNMP_NotifyPrepare | Collects trap notification info and send ARP to remote host.
TCPIP_SNMP_TrapTimeGet | Gets SNMP Trap UDP client open socket time-out.
TCPIP_SNMP_ClientGetNet | Get a network interface for SNMP TRAP.
TCPIP_SNMP_ExactIndexGet | To search for exact index node in case of a Sequence variable.
TCPIP_SNMP_IsValidCommunity | Validates community name for access control.
TCPIP_SNMP_IsValidLength | Validates the set variable data length to data type.
TCPIP_SNMP_MibIDSet | Sets the agent MIB ID for SNP notification.
TCPIP_SNMP_NextIndexGet | To search for next index node in case of a Sequence variable.
TCPIP_SNMP_ReadCommunityGet | Gets the readCommunity String with SNMP index.
TCPIP_SNMP_RecordIDValidation | Used to restrict the access dynamic and non dynamic OID string for a particular SNMP Version.
TCPIP_SNMP_SendFailureTrap | Prepares and validates the remote node that will receive a trap and send the trap PDU.
TCPIP_SNMP_TrapInterFaceSet | Sets the TRAP interface for SNMP notification.
TCPIP_SNMP_TRAPMibIDGet | Gets the agent MIB ID for SNP notification.
TCPIP_SNMP_TrapSendFlagGet | Gets the status of trap send flag.
TCPIP_SNMP_TrapSendFlagSet | Sets the status of trap send flag.
TCPIP_SNMP_TrapSpecificNotificationGet | Gets the specific trap.
TCPIP_SNMP_TrapSpecificNotificationSet | Sets the specific trap, generic trap, and trap ID.
TCPIP_SNMP_VarbindGet | Used to get/collect OID variable information.
TCPIP_SNMP_VarbindSet | Sets the MIB variable with the requested value.
TCPIP_SNMP_WriteCommunityGet | Gets the writeCommunity String with SNMP index.
TCPIP_SNMP_AuthTrapFlagGet | Gets the status of authentication trap flag.
TCPIP_SNMP_AuthTrapFlagSet | Sets the status of authentication trap flag.
TCPIP_SNMP_IsTrapEnabled | Gets the SNMP Trap status.
TCPIP_SNMP_ReadCommunitySet | Sets the readCommunity String with SNMP index.
TCPIP_SNMP_SocketIDGet | Gets the Socket ID for SNMP Server socket.
TCPIP_SNMP_SocketIDSet | Sets the Socket ID for SNMP Server socket.
TCPIP_SNMP_Task | Standard TCP/IP stack module task function.
TCPIP_SNMP_TRAPTypeGet | Get SNMP Trap type for version v1 and v2c.
TCPIP_SNMP_TRAPv1Notify | Creates and Sends TRAPv1 pdu.
TCPIP_SNMP_TRAPv2Notify | Creates and sends TRAP PDU.
TCPIP_SNMP_ValidateTrapIntf | Gets the status of trap interface.
TCPIP_SNMP_WriteCommunitySet | Sets the writeCommunity String with SNMP index.
SNMPv3 Module Functions |
TCPIP_SNMPV3_EngineUserDataBaseGet | Get SNMPv3 engine data base details.
TCPIP_SNMPV3_EngineUserDataBaseSet | Set SNMPv3 engine data base details.
TCPIP_SNMPv3_TrapConfigDataGet | Gets the SNMPv3 Trap configuration details using the user name index.
TCPIP_SNMPv3_Notify | Creates and Sends SNMPv3 TRAP PDU.
TCPIP_SNMPV3_TrapTypeGet | Gets SNMP Trap type for version v3.
SNMP Data Types and Constants |
SNMP_COMMUNITY_TYPE | Definition to represent different type of SNMP communities.
SNMP_END_OF_VAR | This Macro is used for both SNMP SET and GET Variable processing to indicate the end of SNMP variable processing. For multi byte data request, the end byte will be always SNMP_END_OF_VAR.
SNMP_INDEX_INVALID | This Macro is used for both SNMP SET and GET Sequence Variable processing. SNMP starts processing the start of sequence variable with Invalid index. TCPIP_SNMP_ExactIndexGet and TCPIP_SNMP_NextIndexGet returns a valid index as per SNMP_INDEX_INVALID.
SNMP_NON_MIB_RECD_INFO | Restrict access for specific OIDs.
SNMP_START_OF_VAR | This Macro is used for both SNMP SET and GET Variable processing to indicate the start of SNMP variable processing. For multi byte data request, the first byte will be always SNMP_START_OF_VAR.
SNMP_TRAP_IP_ADDRESS_TYPE | Definition of the supported address types for SNMP trap.
SNMP_VAL | Definition to represent SNMP OID object values.
SNMP_ID | SNMP dynamic variable ID.
SNMP_INDEX | SNMP sequence variable index.
SNMP_V1 | This macro is used for SNMP version 1
SNMP_V2C | This macro is used for SNMP version 2 with community
SNMP_V3 | This macro is used for SNMP version 3 with authentication and privacy
SNMP_GENERIC_TRAP_NOTIFICATION_TYPE | Definition to represent different SNMP generic trap types.
SNMP_VENDOR_SPECIFIC_TRAP_NOTIFICATION_TYPE | Definition to represent different SNMP vendor trap types.
SNMPv3 Data Types and Constants |
SNMPV3_HMAC_HASH_TYPE | Different type of authentication for SNMPv3.
SNMPV3_PRIV_PROT_TYPE | Different type of encryption and decryption for SNMPv3.
STD_BASED_SNMP_MESSAGE_PROCESSING_MODEL | Different SNMP Message processing model
STD_BASED_SNMP_SECURITY_MODEL | Different Security services for SNMPv3 messages.
STD_BASED_SNMPV3_SECURITY_LEVEL | Different Security Level for SNMPv3 messages.
TCPIP_SNMPV3_USERDATABASECONFIG_TYPE | Different Configuration parameters of SNMPv3 operation
TCPIP_SNMP_COMMUNITY_CONFIG | SNMP community configuration.
TCPIP_SNMP_MODULE_CONFIG | SNMP module configuration.
TCPIP_SNMPV3_TARGET_ENTRY_CONFIG | SNMP module trap target address configuration.
TCPIP_SNMPV3_USM_USER_CONFIG | SNMPv3 USM configuration.