API Management 10.4 | Using API Gateway | API Gateway Administration | Destination Configuration | Configuring SNMP Destination
 
Configuring SNMP Destination
You have to configure SNMP as a destination to send the events to a third-party SNMP server.
* To configure SNMP destination
1. Expand the menu options icon , in the title bar, and select Administration.
2. Select Destinations.
3. Select SNMP.
4. Provide the following information:
Field
Description
Send TRAPs to 3rd party SNMP server
Specifies API Gateway to use the SNMP traps to capture events that you can send to a third-party SNMP server.
SNMP target type
Specifies target type of the SNMP server. The available options are:
*User: To send the events information to a SNMP user.
*Community: To send the events information to a group of SNMP users that form a community.
By default, User is selected.
Hostname
The host name or IP address of the machine where the CentraSite SNMP or the third-party SNMP server is installed and running.
Note: The host name cannot be localhost.
Port
The SNMP trap receiver port that is listening for SNMP requests and packets.
Transport
The protocol used by SNMP to send traps. The available options are: TCP and UDP. By default, TCP is selected.
If you select UDP, ensure that the SNMP server is in the same subnet, or configure the routers to get packets across subnet boundaries. The maximum PDU size when running in UDP mode is 64 Kb which might be restrictive when sending large request and response payloads for Transaction Events.
Username
If User is selected as the SNMP target type, then the Username field specifies the SNMPv3 user name to use when connecting to the receiver.
If Community is selected as the SNMP target type, then the Community name field specifies the name to be used to interact with the SNMP receiver. This value must match the value that you set in the SNMP receiver.
Use authorization
Specifies whether an authorization key is required. You cannot edit the authorization fields unless Use authorization option is selected. The authorization fields are:
*Password: The key to be used for authorization.
*Protocol: The authorization protocol is MD5
Use privacy
Specifies whether a privacy (encryption) key is required. You cannot edit the privacy fields unless Use privacy option is selected. The privacy fields are:
*Password: The key to be used for privacy.
*Protocol: The privacy protocol is DES.
5. Click Save to save the specified SNMP configuration value.
You can click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.
Post-requisites:
After performing the server configurations, select SNMP as a Destination in the Policies properties page for each policy, to receive the transaction events logs for the assigned policies.
Note: Metrics is not supported for third-party SNMP server.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release