6.3.20 TCP agent definition file (ssotcpagent.conf)
In the TCP agent definition file, define the APM to be a target of TCP health check.
- Organization of this subsection
(1) Format
In a TCP agent definition file, specify the definition for each agent on a line. Delimit each definition item with a colon (:). Note the following when creating the TCP agent definition file:
-
The TCP health check is performed for a specified agent only when the version of the APM on the specified agent is 08-00 or later. For other agents, the health check by using SNMP (UDP) is performed as normal.
-
If no TCP agent definition file is found in the $SSO_CONF directory, the health check by using SNMP (UDP) is performed for all agents as normal.
-
If the definition file includes multiple definitions for the same agent, the definition written first is assumed to be valid, and the other definitions are ignored. Therefore, if a definition specifying *.*.*.* as the IP address of the monitoring target agent is written at the top of the definition file, that definition applies to all agents.
-
To apply updates in this definition file, restart the ssoapmon daemon process or execute the ssoapcom -r command.
(2) Details of definition
Item |
Value |
---|---|
IP-address |
Specify the IP address of the monitoring target agent in the n.n.n.n format. For n, you can specify a value from 0 to 255 or an asterisk (*) or question mark (?) as a wild card. |
port-number <<20307>> ((1 to 65535)) |
Specify the port number to be used to perform the health check for the monitoring target agent. The port number must match the value of the LISTENPORT key in the TCP service definition file on the monitoring target agent. |
response-monitoring-time <<50>> ((10 to 36000)) |
Specify the response monitoring time during the health check for the monitoring target agent. Specify the time in units of 1/10 second. |
retry-count <<1>> ((0 to 99)) |
Specify the number of retries to be attempted when the health check on the monitoring target agent fails. |
(3) Example
The following shows an example of a TCP agent definition file.