TCPIP Configuration Syntax

Adding servers to the AVAILABILITY configuration will provide both STATUS and RESPONSE TIME information for server entities. This can include any device with an IP address such as a router or network printer.

Servers/devices to be monitored must be connected via a LAN and must be utilizing the TCP/IP protocol stack.

When you add a server to your AVAILABILITY configuration you are monitoring it from the point of view of the machine you start the AVAILABILITY configuration on.

For example, if you have an Availability configuration on a server called \UNIVERSE and you add to the configuration a TCPIP HOST called \REMOTE and another called \OTHER. You will not be able to receive response statistics between \REMOTE and \OTHER but you will get response statistics from \UNIVERSE to \OTHER and \UNIVERSE to \REMOTE.

The same applies to State information. If the server \OTHER is said to be DOWN, this is from the point of view of \UNIVERSE. The network connection between \OTHER and \REMOTE could still be active and AVMON data (if configured) on \REMOTE would show \OTHER as UP.

The following syntax applies to TCP/IP host entities in the AVAILABILITY configuration.

SUBSYS AVAILABILITY

TCPIP HOST (<HostName>, <IPAddress[, [<MonInterval>, <MonIntervalUnit>], <MonProcess>])
TCPIP HOSTLOOKUP (<HostFileName>[, [<MonInterval>, <MonIntervalUnit>], <MonProcess>])
TCPIP MAXHOSTS (50)
TCPIP TIMEOUT (<TimeOut>)
TCPIP MONINT (<MonInterval>, <MonIntervalUnit>)
TCPIP PROCNAME (<MonProcess>)

TCPIP SCHEDULE (<EntityName>, <ScheduleName>)
TCPIP SCHEDULEWHERE (<WhereClause>, <ScheduleName>)
TCPIP TARGET (<EntityName>, <TargetValue>)
TCPIP TARGETWHERE (<WhereClause>, <TargetValue>)
TCPIP OUTAGE (NO)

Syntax Elements

TCPIP HOST

Includes the device identified by <HostName> in the availability configuration. These settings will override the global setting TCPIP MONINT described below and apply it to this device only. Using this setting each device can have its own data collection interval.

<hostname>

DNS name defined for this computer in your Windows TCPIP network configuration (max 60 characters). The DNS name is not used at this stage for resolution but it is necessary to give a meaningful name to data collected on this device.

<ip-address>

The IP address of the host to be monitored in dotted decimal form. Take care when monitoring devices using Dynamic IP assignment through DHCP as this can result in misleading information when an IP address changes. The DNS name is not used at this stage for resolution but it is necessary to give a meaningful name to data collected on this device.

<MonInterval>

The time interval between response time measurements. The time interval will take effect when the AVAILABILITY Configuration is started and will continue to maintain that interval through every subsequent hour. No re-alignment takes place on the hour. Specified in units of <MonIntervalUnit>.

<MonIntervalUnit>

Unit of measurement for <MonInterval>. Valid values are:
S, SEC, SECOND, SECONDS,
M, MIN, MINUTE, MINUTES,
H, HOUR, HOURS

<MonProcess>

The process name of the TCP/IP process to be used for connecting to a remote TCP/IP host. When including this parameter here also add <MonInterval>, <MonIntervalUnit>, <MonProcess> in that order. This parameter will override any <MonProcess> that has been included at the TCPIP PROCNAME statement for this entry.

TCPIP HOSTLOOKUP

It provides a more convenient way to add TCPIP hosts to the AVAILABILITY configuration by utilizing the entries in the local system’s HOST file. When the AVAILABILITY configuration is started the hostnames listed and their IP addresses are automatically added and monitored.

<HostFileName>

Path and name of the file storing the list of hosts. On Windows(SystemRoot\System32\Drivers\Etc\Hosts).

<MonInterval>

The time interval between response time measurements. The time interval will take effect when the AVAILABILITY Configuration is started and will continue to maintain that interval through every subsequent hour. No re-alignment takes place on the hour. Specified in units of <MonIntervalUnit>.

<MonIntervalUnit>

Unit of measurement for <MonInterval>. Valid values are:
S, SEC, SECOND, SECONDS,
M, MIN, MINUTE, MINUTES,
H, HOUR, HOURS

<MonProcess>

The process name of the TCP/IP process to be used for connecting to a remote TCP/IP host. When including this parameter also add <MonInterval>, <MonIntervalUnit>, <MonProcess> in that order. This parameter will override any <MonProcess> which has been included at the TCPIP PROCNAME statement for this entry.

TCPIP MAXHOSTS (50)

This token is valid only with the TCPIP HOSTLOOKUP <HostFileName> option. It limits the TCP/IP entries to be read from the Hosts File specified by the <HostFileName>. When this option is not used AVMON will read all entries from the host file and monitor them.

TCPIP TIMEOUT

Determines the timeout length for obtaining a response from all monitored TCPIP devices configured above. If a response is not received from any monitored TCP/IP device within this timeframe the device or host is considered to be DOWN. The default is 10 seconds.

<timeout>

TCPIP response timeout value in seconds. A TCP/IP host is considered unavailable if it does not respond within this time.

TCPIP MONINT

Specifies the global sampling interval for all entries that have not specified their own individual monitoring intervals. <MONINT> parameters specified in individual TCPIPHOST entries above will always override this global interval.

<MonInterval>

The time interval between response time measurements. The time interval will take effect when the AVAILABILITY Configuration is started and will continue to maintain that interval through every subsequent hour. No re-alignment takes place on the hour. Specified in units of <MonIntervalUnit>.

<MonIntervalUnit>

Unit of measurement for <MonInterval>. Valid values are:
S, SEC, SECOND, SECONDS,
M, MIN, MINUTE, MINUTES,
H, HOUR, HOURS

TCPIP PROCNAME

The default HPE NonStop TCP/IP process name. This value will be used when a <proc-name> is not specified by a TCPIP HOST or TCPIP HOSTLOOKUP entry.

<MonProcess>

The process name of HPE NonStop TCP/IP process to be used for connecting to remote TCP/IP host. You should specify a TCP/IP process that is capable of connecting to the host(s) specified. Defaults to the system default TCP/IP process name.

Availability-Scheduled Outages

For detailed information about the following entries please refer to the Scheduled Availability Outages.

TCPIP SCHEDULE

This entry is used to attach a monitoring schedule to an entity. This schedule is created through the SCHEDULE Configuration and is used to define periods when the specified entity is to be monitored. Any periods outside of the schedule are recorded as schedule outages and any outages recorded during the monitored period are treated as unscheduled outages.

<EntityName>

Name of the entity to be monitored. This can be a specific entity name or wild cards '*' or '?' can be used to indicate a range of entities.

<ScheduleName>

Name of the schedule as defined in the SCHEDULE Configuration.

TCPIP SCHEDULEWHERE

This entry is used to attach a schedule to an entity by using a specified Where Clause. Currently, only the ID, SUBID1 and SUBID2 fields can be used in Where Clauses for this entity type.

TCPIP TARGET

Service level targets based upon availability percentage can be specified for an entity. The target value can be specified to six decimal places. The percentage sign '%' is not required as it is implied that the value specified is a percentage.

TCPIP TARGETWHERE

This entry is used to specify a service level target to an entity by using a specified Where Clause. Currently, only the ID, SUBID1 and SUBID2 fields can be used in Where Clauses for this entity type.

TCPIP OUTAGE

By default, the Availability collector will generate detailed outage records for all entities. The generation of outage records can be stopped for a particular Availability associate by setting the TCPIP OUTAGE entry to NO.

Provide feedback on this article