pg.cs.snmpTarget.
These properties specify the settings for Mediator to use with the CentraSite SNMP server, which uses the SNMPv3 user-based security model.
Note: | The default values are synchronized with the defaults used by CentraSite's SNMP Event Listener configuration file CentraSite_directory/cast/cswebapps/SOALinkSNMPEventsListener/WEB-INF/web.xml. The settings in both files must match. |
pg.cs.snmpTarget.authProtocol
Specifies the authorization protocol to use for securing SNMPv3 messages. Valid values are MD5 (default) and SHA.
You can edit this parameter from the Authorization Protocol field on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.base64Encoded
This is an internal parameter. Do not modify.
pg.cs.snmpTarget.connTimeout
Specifies the number of milliseconds before an inactive connection to the SNMP target server is closed. If set to 0, the socket remains open indefinitely.
pg.cs.snmpTarget.ipAddress
Specifies the IP address of the CentraSite SNMPv3 server.
You can edit this parameter from the Host Name/IP Address field on the Mediator > Administration > SNMP page in Integration Server Administrator. You cannot set this parameter to localhost.
Important: | If you do not set this parameter properly, the traps might not reach the SNMP server. Mediator will still send events as SNMP traps, but because there is no mechanism for acknowledging traps that are configured incorrectly, the SNMP server will not return errors when settings are incorrect. |
pg.cs.snmpTarget.maxRequestSize
Specifies the maximum size (in bytes) for SNMP traps. The default is 10485760.
pg.cs.snmpTarget.port
Specifies the SNMP trap receiver port on the CentraSite server that is listening for SNMP requests and packets. The default is 8181.
You can edit this parameter from the Port field on the Mediator > Administration > SNMP page in Integration Server Administrator.
Note: | If Microsoft Internet Information Services (IIS) is installed (or will be installed) on the same machine hosting Integration Server/Mediator, then you may want to change the default SNMP port of 8181 to something else, to avoid any potential runtime conflicts when sending SNMP packets. |
pg.cs.snmpTarget.privProtocol
Specifies the privacy protocol to use for SNMPv3 messages. Valid values are DES (default), AES128, AES192, AES256, 3DES, and DESEDE.
You can edit this parameter from the Privacy Protocol field on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.retries
Specifies the number of times to resend SNMP traps upon failure. The default is 1.
This parameter works with pg.cs.snmpTarget.sendTimeOut to determine the delay in re-sending SNMP traps to malfunctioning SNMP servers (that is, it retries*sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there will be a 1.5 second delay before the Mediator thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes Mediator to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.cs.snmpTarget.sendTimeOut
Specifies the amount of time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that will resend an SNMP event that has not yet completed when it expires. You must set a timeout value that ensures that the trap is sent to the SNMP server within the time frame. This parameter does not abort an event that is in progress. Set this parameter higher than the default when sending traps with large payloads. The default is 500.
This parameter works with pg.cs.snmpTarget.retries to determine the delay in re-sending SNMP traps to malfunctioning SNMP servers (that is, it retries *sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there will be a 1.5 second delay before the Mediator thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes Mediator to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.cs.snmpTarget.sendTraps
Specifies whether to send traps to the CentraSite SNMPv3 server. The default is false.
You can edit this parameter from the Send Traps to CentraSite option on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.transportProtocol
Specifies the protocol used by SNMPv3 to send traps. Valid values are TCP (default) and UDP.
You can edit this parameter from the Transport field on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.useAuth
Specifies whether an authorization key is required. The default is false.
You can edit this parameter from the Use Authorization check box on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.usePrivacy
Specifies whether a privacy (encryption) key is required. The default is false.
You can edit this parameter from the Use Privacy check box on the Mediator > Administration > SNMP page in Integration Server Administrator.
pg.cs.snmpTarget.userName
Specifies the SNMPv3 user name to use when connecting to the receiver.
You can edit this parameter from the User Name field on the Mediator > Administration > SNMP page in Integration Server Administrator.