TCPConnectionTest

Trigger this action to test connectivity to a remote host using a specific port.

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

{
  "TCPConnectionTest": {
    "RemoteHost": "host",
    "RemotePort": "port",
    "Timeout": seconds,
    "useIPv": "IP_address_format",
    "LocalAddress": "IP_address"
    }
}

RemoteHost: String; Specify a host name or IP address.
RemotePort: String; Specify the port number.
Timeout: Int; Specify the timeout for this connection attempt in seconds.
useIPv: String; Optionally specify the format of the 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 connection test.

Example

To test the connection to port 5554 of the host williamswillow.co.uk with a twenty second timeout, post the following payload to https://yourhost:5554/mgmt/actionqueue/default:

{
  "TCPConnectionTest": {
    "RemoteHost": "williamswillow.co.uk",
    "RemotePort": "5554",
    "Timeout": 20
    }
}