Ping Endpoint Plugin

Ping protocol plugin allows for ICMP Ping messages toward endpoints.

Configuration

The following configuration can be set:

SettingTypeDefaultDescription
DontFragmentbooleanfalseControls if fragmenting is allowed
HoststringlocalhostHost name or IP address
Timeoutduration1sICMP timeout
TTLi3264Time to live

Example: Host Setup

The following example sets the host.

@Ping {
    Host example.com
}

Example: All

The following example sets all configurable properties.

@Ping {
    Host         example.com
    DontFragment true
    Timeout      0.5
    TTL          8
}

Outgoing Message “Send”

Outgoing message will send ping request.

DataTypeDefaultDescription
DontFragmentboolean(configuration)Controls if fragmenting is allowed
Timeoutduration(configuration)ICMP timeout
TTLi32(configuration)Time to live

Example: Basic

We can send message without any extra paramters.

Send >Ping

Example: Override TTL

We can override any parameter (other than Host) in the outgoing message.

Send >Ping {
    TTL 4
}

Incoming Message “Reply”

Reply will arrive with status of the ping.

DataTypeDescription
AddressipAddress that replied to ping
StatusstringWill be Success if operation succeeds
RoundtripTimedurationHow long it took for the ping reply

Example: Basic

Successful response.

Reply <Ping {
    Address "1.1.1.1"
    Status Success
    RoundtripTime "0.013s"
}

Example: Failure

Timed out response.

Reply <Ping {
    Address "192.168.253.254"
    Status  TimedOut
}