TestPing

You can use the TestPing method to test network connectivity to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. The test uses the appropriate MTU sizes for each packet based on the MTU settings in the network configuration.

Parameters

This method has the following input parameter:

Name Description Type Default value Required
attempts Specifies the number of times the system should repeat the test ping. integer 5 No
hosts Specifies a comma-separated list of addresses or hostnames of devices to ping. string The nodes in the cluster No
totalTimeoutSec Specifies the time in seconds the ping should wait for a system response before issuing the next ping attempt or ending the process. integer 5 No
packetSize Specifies the number of bytes to send in the ICMP packet that is sent to each IP. The number of bytes must be less than the maximum MTU specified in the network configuration. integer None No
pingTimeoutMsec Specifies the number of milliseconds to wait for each individual ping response. integer 500 ms No
prohibitFragmentation Enables the DF (Do not Fragment) flag for the ICMP packets. boolean false No

Return value

This method has the following return value:

Name Description Type
details List of each IP the node was able to communicate with. JSON object

Request example

Requests for this method are similar to the following example:

{
   "method": "TestPing",
   "params": {
            "totalTimeoutSec": 3,
            "attempts": 4,
            "hosts": "127.0.1.1"
},
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
    "result": {
      "result": "Passed",
      "duration": "0.0193463sec",
      "details": {
        "127.0.1.1": {
        "successful": true,
        "responseTime": "00:00:00.000035",
        "individualStatus": [
          true,
          true,
          true,
          true
        ],
        "individualResponseTimes": [
           "00:00:00.000043",
           "00:00:00.000020",
           "00:00:00.000052",
           "00:00:00.000023"
        ]
      }
   }
 },
 "id": 1
}