Ping Machine Action

Declaration

<AMPING HOST="text" TIMEOUT="number" RESULTVARIABLE="text">

See Also

Send Email, Dial Up, HTTP Download, Open a Webpage, HTTP Post

Description

Sends a "ping" request to a computer. Ping is used to test server response times on a TCP/IP network. If the computer does not respond within the time specified, the step generates an error.

Practical Usage

Used to check response times of servers connected to the Internet or private TCP/IP network.

Parameters

General Tab

Hostname or IP

Text, Required
MARKUP: HOST="http://www.networkautomation.com"

Specifies a hostname or IP Address that should be "pinged". This value can be a hostname such as server.domain.com or an IP address such as 555.555.555.555.

Time to Wait

Number, Required - Default YES
MARKUP: TIMEOUT="30"

Specifies how long the step should wait (in seconds) before generating an error if there is no response from the server being "pinged".

Variable

Text, Optional - Default NONE
MARKUP: RESULTVARIABLE="varname"

Specifies the variable to populate with the response time (in milliseconds).

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMPING HOST="server.domain.com" RESULTVARIABLE="responsetime">