---
schema_version: "1"
id: 65e5bab7be9a7c6eaa6b32b99d374bb446eb355097272ab334048d56e1cc546a
title: Ping
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/rpa-builder/6.6/toolbox-network-ping.md
canonical_url: https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network-ping
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 0fe0d66974cc5773e1dcc47129f03b7133558ed130111f8a2eeb03c1545132ca
description: MuleSoft Documentation Site
release: "6.6"
latest: false
---
---
product: RPA Builder
version: 6.6
---

# Ping

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This _Action Step_ is used for sending a ping to a computer or network device. _Ping_ is useful to
check if a particular machine is available on the network right at the start of a measurement
_Workflow_. If not, it may be pointless to even try to continue the measurement.The response time
measured provides a _Measurement Point_.

The Action Step _Ping_ only supports IPv4.

## Properties

**Invert Logic** If it is intentional that the destination host should be unreachable and you want
to test this, you can invert the logic of the _Ping_ _Action Step_ by using this function. If the
checkbox is selected, then an unsuccessful ping is considered to be the correct result.

**Show message box** Defines if a message box with the measured response time should be displayed
after the _Ping_ action is finished.

**Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can
change the number of _Pings_ sent by editing the value in the text field. The resulting response
time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_
results in an error and the timer will be unavailable.

**Destination Host** Enter the IP or hostname of the machine you want to ping.

**ICMP Packet size** Defines the size of the data package that is used for the _Ping_.

High values may create a lot of network traffic!

**ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by
exceeding the set ICMP timeout.

**ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response
from the destination host.

**Ping delay \[ms\]** Pause time between _Ping_ retries.

**Ping Threshold \[ms\]** Defines the allowed duration of a _Ping_ response. If the response exceeds
this duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If
_Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling.

**Record Timer** If activated, the _Ping_ response time will be recorded like a _Timer_ or
_Stopwatch_ and thus contribute to the reports in RPA Manager.

**Timer Mode** When "Record Timer" is enabled and the _Ping_ is used in a loop, the following mode
is for calculating the timer value:

- **Last** The last time measured is saved

- **Average** The script calculates an average of all times measured and saves it

- **Min** The fastest time measured is saved

- **Max** The slowest time measured is saved

## Inbound Variables

**Suffix** can be used if the _Ping_ is within the _Control Block_'s _File Controlled Loop_. A
suffix is then added to the name of the _Ping_ during every loop. Each suffix is a column entry in
the file that was imported in the _File Controlled Loop_.

**Destination Host** Enter the IP or hostname of the machine you want to ping.

**ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by
exceeding the set ICMP timeout.

**ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response
from the destination host.

**ICMP Packet size** Defines the size of the data package that is used for the _Ping_.

**Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can
change the number of _Pings_ sent by editing the value in the text field. The resulting response
time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_
results in an error and the timer will be unavailable.

**Ping Delay** Pause time between _Ping_ retries.

**Ping Threshold** Defines the allowed duration of a _Ping_ response. If the response exceeds this
duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If
_Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling.

## Outbound Variables

**Time** provides you the measured time.

## Wizard

See [Properties](#properties).