Network Utilities › Get Network Service Status Operator › Input Parameters

Input Parameters

Remote Hostname

Specifies the hostname or FQDN of the computer that hosts the service.

Default

Blank - Indicates that the operator assumes that the service is running on the touchpoint host.

Remote Port

Specifies the host port on which the service is listening. Some well-known and registered ports include the following:

• 21: FTP - File Transfer
• 22: SSH - The Secure Shell (SSH) Protocol
• 23: Telnet
• 2483: Oracle TTC
• 25: SMTP - Simple Mail Transfer
• 3306: MySQL
• 69: TFTP - Trivial File Transfer
• 80: HTTP
• 1433: Microsoft SQL Server

You can specify any valid port in this field.

Local Port Number (0 for anonymous port)

Specifies the local port that the Get Network Service Status operator uses on the touchpoint host to connect to the remote port.

Values

• 0 - Indicates that an anonymous port is used.
• Blank - Same as 0.

Note: If the specified port is unavailable, the operator fails.

Protocol to Use

Specifies the protocol to use when verifying the status of the service and sending data. If UDP is specified, the Connection Timeout (sec) field is disabled because UDP is a connectionless protocol.

Values

This value can be one of the following:

• TCP
• UDP

Default

TCP (if left blank).

Connection Timeout (sec)

Specifies the maximum amount of time that the operator waits for a connection to the service before timing out. This field is applicable to TCP protocol only.

Values

This value can be one of the following:

• 0 (zero) - Indicates no timeout.
• Any positive integer (in seconds)

Default

20 seconds (if blank)

Data to send

(Optional) Specifies data to send to the service. Most services do not expect any data.

Read Data from Service?

Specifies whether the operator reads data from the service after contacting it.

Values

This value can be one of the following:

• Selected - Indicates that the operator reads data from the service after contacting it. Select this option to enable Time to Read Data (sec), Max Data to Read (bytes), and Reply Pattern to match fields.
• Cleared - Indicates that the operator does not read data from the service after contacting it. This value is appropriate for services that do not return data.

Notes:

• With UDP, all the data (if any) is read at once. If there is no data, the operator waits until the Time to Read Data is up. All the Max Data to Read is read at once in a string of length Max Data to Read.
• With TCP, the operator reads the data in chunks until it reaches one of the following thresholds:
  • Time to Read Data
  • Max Data to Read

Time to Read Data (sec)

Specifies the amount of time to spend waiting for reply data from the service. This field is specified because the data from the service does not have an EOF at the end.

Values

This value is a positive integer. Zero (0) is not allowed. Otherwise, the operator would wait for a long time until the service closes the socket.

Default

20 seconds (if blank).

Max Data to Read (bytes)

Specifies the maximum amount of data to read from the service.

Default

4096 bytes

Reply Pattern to match

(Optional) Specifies a pattern to use to match the data returned from the service. If specified, pattern matching determines whether the operator succeeds or fails.

The operator matches the pattern against the data read during the time period specified in Time to Read Data up to the number of bytes specified in Max Data to Read.

The operator matches the pattern as a substring of the reply data.

• To match reply data that starts with a specific sequence, use ^ at the beginning of the pattern.
• To match reply data that ends with a specific sequence, use $ at the end of the pattern.
• To match a new line terminator, use dot (.). Dot is used to match multiline reply data.