QOS User's Manual
Prev Next

Tcp

Name

Tcp -- Check TCP port connectivity

Synopsis

{ 'type'      : 'Tcp' , 
  'subents'   : [ 
                 {
                  'status'   : 'on' ,
                  'name'     : 'mx1.example.com',
                  'tcpHost'  : '12.34.56.78',
                  'tcpPort'  : '25',
                  'goodPhrase'  : '220 example.com ESMTP',
                  'triggers' : [{ 'level' : 'warn', 'trigger' : '5' }, ],
              }
            ]
}

Description

The Tcp Entity monitors the availability of TCP servers by pinging the server, connecting to their port and reading any response. The entity can check for a particular response phrase. The Entity reports the number of pings dropped, the ping time in seconds, the connect time in seconds, the time to send a message (if specified), and the time to receive a response from the server.

Fields

name

A descriptive name for this subentity.

tcpHost

The hostname or IP address of the host to monitor.

tcpPort

The port to connect to on tcpHost.

goodPhrase

(Optional) The text to match on a successful connect. If not specified, a phrase is not checked for.

tcpHelo

(Optional) The text to send immediately after connection. This can be used to "wake up" servers that require a client inquiry before returning a response.

Trigger

The Trigger fires if the port is not reachable (connection times out or is refused), if the goodPhrase is not read, or if the timeout specified as the trigger (in seconds) expires.

Prev Home Next
Snmp Up Transaction