Ping - Version 2.0.1#
Module Summary#
Send an ICMP ping to monitor the online status of a remote peer.
Module Status#
This IO Module is stable and has been tested internally.
If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.
Release Notes#
Version 2.0#
Initial release.
Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.
Operation#
Instance Properties#
Set the Host to the hostname or IP address of the remote peer to monitor.
Enabling Auto Ping? will automatically send a ping every Auto Ping Interval with a reply timeout of Auto Ping Timeout.
TTL can be used to alter the Time To Live.
Every device (such as an intermediate router) forwarding an IP datagram first decrements the time to live (TTL) field in the IP header by one. If the resulting TTL is 0, the packet is discarded.
In most cases this should remain as the default value.
Checking the Extended Logging checkbox will provide more detailed log messages. This is intended for diagnostics and problem solving and should ideally be disabled during normal operation.
Status Variables#
The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.
| Status | The current peer status
|
| Average time | Average round trip time |
| Packet loss | Percentage of pings with no response |
Triggers#
Ping Reply#
Fires when the Controller receives a ping reply.
Trigger variables:
Variable 1: IP Address of responder.
Variable 2: Round trip response time (ms).
Variable 3: TTL of response.
Ping Timeout#
Fires when the Controller times out waiting for a ping reply.
Conditions#
Online#
Returns true if the remote peer responded to the last ping request.
Actions#
Send Ping#
Sends one ping only to the remote peer, expecting a reply withing Timeout milliseconds.
n.b. This cancels any other pending timeouts for this module instance.
Support#
If you encounter any issues with this module, please contact our support team.