X4 Produktdokumentation

Ping

This adapter pings an IP address via the Internet Control Message Protocol. In doing so, the adapter sends ICMP ECHO REQUESTs or alternatively tries to establish a TCP connection on port 7. If previous connection requests fail and the port is set to a value other than 7, another TCP request is sent to the specified port. The adapter outputs an XML document containing the result of the echo (true or false).

Properties

Operation

Determines which operation the adapter executes

Possible values:

  • Ping: Execute ping

Parameters

iPAddress

IP address to which the ping is sent

Possible values:

  • Any IP address (e.g. 127.0.0.1)

  • 0.0.0.0: Empty IP address (default)

timeout

Time limit for establishing connection in milliseconds

Possible values:

  • Any positive integer

  • 0: No time limit (default)

port

Port to retry connection if the first ICMP request fails

Possible values:

  • Any positive integer


Status values

1

The operation was executed successfully.

0

The operation was executed successfully, but without any result.

-1

The operation failed due to a technical error.