Communication - Ping¶

Plugin details¶

Type: Communication

Name: Ping

Status: COLLECTION

Maintainer: TD-er

Used libraries: .

Description¶

The Ping plugin is designed to check the availability of a local or remote device or host that can be reached via TCP/IP, and responds to ICMP requests (ping). If no response is received, the Fails counter is incremented, if the connection is restored after temporarily being disturbed, the Fails counter is auto-reset to 0.

Configuration¶

Name A unique name should be entered here.
Enabled The device can be disabled or enabled. When not enabled the device should not use any resources.

Device Settings¶

Hostname: The hostname or IP-address for the device or host to monitor.

Data Acquisition¶

This group of settings, Single event with all values and Send to Controller settings are standard available configuration items. Send to Controller is only visible when one or more Controllers are configured.

Interval By default, Interval will be set to 60 sec. Every Interval setting, the host will be pinged and the state will be updated in Fails. If the ping responds as intended, then Fails is reset to 0.

Values¶

The failure count value is available in Fails. No other options are available for Values.

Commands available¶

Command	Extra information
`pingset,<value>` `pingset,<taskname>,<value>` (deprecated) `<taskname>`: Name of the `Ping` task. `<value>`: The value to set the Fails counter to, range: -1023 .. 1023. Examples: `pingset,ping,0`: Reset the Fails counter for task `ping`. (deprecated) Preferred syntax: `pingset,0`: Reset the Fails counter (alternative syntax) `[ping1].pingset,-10`: Set a specific instance of the Ping plugin. `[ping2].pingset,0`: Set another instance of the Ping plugin.	Set the Fails counter for the task. The deprecated syntax was instated before the generic task-specific command addressing, using `[<taskname>].` prefixing, was introduced.

Command

Extra information

pingset,<value>

pingset,<taskname>,<value> (deprecated)

<taskname>: Name of the Ping task.

<value>: The value to set the Fails counter to, range: -1023 .. 1023.

Examples:

pingset,ping,0: Reset the Fails counter for task ping. (deprecated)

Preferred syntax:

pingset,0: Reset the Fails counter (alternative syntax)

[ping1].pingset,-10: Set a specific instance of the Ping plugin.

[ping2].pingset,0: Set another instance of the Ping plugin.

Set the Fails counter for the task.

The deprecated syntax was instated before the generic task-specific command addressing, using [<taskname>]. prefixing, was introduced.

Change log¶

Changed in version 2.0: …

changed 2023-03-14 Extended command handling to not require the taskname argument.

added 2020-02-22