Ping

Trigger this action to ping a remote host.

Use the HTTP POST method with the resource /mgmt/actionqueue/default, specifying a request payload with the following format:

{
  "Ping": {
    "RemoteHost": "host",
    "useIPv": "IP_address_format",
    "LocalAddress": "IP_address"
    }
}

RemoteHost: String; Specify a host name or IP address.
useIPv: String; Optionally specify the format of the IP address to identify the IP version to use when resolving an ambiguous host name to an IP address. Specify "-4" for IPv4 (the default), or "-6" for IPv6.
LocalAddress: String; Optionally specify the IP address of a local interface to use for the ping.

The appliance sends Internet Control Message Protocol (ICMP) echo-request messages to the remote host to test connectivity.

Example

To ping the host williamswillow.co.uk, post the following payload to https://yourhost:5554/mgmt/actionqueue/default:

{
  "Ping": {
    "RemoteHost": "williamswillow.co.uk",
    }
}