ICMP Echo Test Tag

Help Contents

Introduction

The Internet Control Message Protocol (ICMP) defines an Echo Request command, which tests whether a remote device is online or offline. The ICMP Echo Request is often called a "Ping".

The ICMP Echo Test Tag allows Fernhill SCADA to perform ICMP Echo Request on a remote device.

Configuration Properties

The ICMP Echo Test Tag supports the configuration properties of the Core Tag plus these properties:

Property Type Version Description
HostName STRING 3.98 The network address of the Device to test. This can be any of the following:
  • An IP Address. For example: 192.168.1.15
  • A node name. For example: PLC
  • A fully qualified domain name. For example: plc.example.com
ReplyTimeout TIME 3.98 How long the driver waits for the reply to the ICMP Echo Request.
IPVersion USINT 3.98 Which IP Version to use: 0 = Any, 1 = IP Version 4, 2 = IP Version 6.
PingInterval TIME 3.98 The interval between each ICMP Echo request. An interval value of zero (T#0s) disables periodic echo requests. See Interval and Offset for information on how timed activities are scheduled.
PingOffset TIME 3.98 The offset added to the PingInterval to get the actual query time. See Interval and Offset for information on how timed activities are scheduled.

Data Properties

The ICMP Echo Test Tag supports the data properties of the Core Tag plus these properties:

Property Type Description
State USINT A code indicating the state of the query. The value 15 shows successful operation. Other values indicate an error. The ErrorMessage property may give additional information.
IsOnline BOOL Whether the remote network device responds to the ICMP Echo Request.
PingTimer TimerStatus The status of the ping timer.

Tag Commands

The ICMP Echo Test Tag supports these tag commands:

Tag Command Version Description
Run 3.98 Requests an immediate ICMP Echo test.

Note: Event triggered data reads (from the Run Tag Command) and periodic data reads (defined by the PingInterval property) are independent. You can use the Run Tag Command, or the PingInterval property, or both to determine when the echo test is run.

Relationships to Other Tag Types

The ICMP Echo Test Tag builds on the features of these tag types:

Further Information

Interval and Offset

To learn how activities are scheduled using Interval and Offset.

I/O Analog Data Point Tag

To learn about the I/O Analog Data Point Tag that can be associated with the ODBC Query Tag.

I/O Digital Data Point Tag

To learn about the I/O Digital Data Point Tag that can be associated with the ODBC Query Tag.

I/O String Data Point Tag

To learn about the I/O String Data Point Tag that can be associated with the ODBC Query Tag.

I/O Word Data Point Tag

To learn about the I/O Word Data Point Tag that can be associated with the ODBC Query Tag.

I/O Double Word Data Point Tag

To learn about the I/O Double Word Data Point Tag that can be associated with the ODBC Query Tag.

Glossary

For the meaning of terms used in Fernhill SCADA.