TestPing

Contributors netapp-mwallis ntap-bmegan Download PDF of this page

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. TestPing does not create a temporary VLAN interface.

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. If no hosts are specified, the method pings the hosts in the storage cluster.

string

None

No

interface

The existing (base) interface from which the pings should be sent. Possible values:

  • Bond10G: Send pings from the Bond10G interface.

  • Bond1G: Send pings from the Bond1G interface.

string

None

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 milliseconds

No

prohibitFragmentation

Enables the DF (Do not Fragment) flag for the ICMP packets.

boolean

false

No

sourceAddressV4

The source IPv4 address to use in the ICMP ping packets.

string

None

No

sourceAddressV6

The source IPv6 address to use in the ICMP ping packets.

string

None

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

virtualNetworkTag

The VLAN ID to use when sending the ping packets.

integer

None

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 and ping response statistics.

JSON object

Request example

Requests for this method are similar to the following example:

{
    "method": "TestPing",
    "params": {
        "interface": "Bond1G",
        "hosts": "192.168.0.1"
    },
    "id" : 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {
    "details": {
      "192.168.0.1": {
        "individualResponseCodes": [
          "Success",
          "Success",
          "Success",
          "Success",
          "Success"
        ],
        "individualResponseTimes": [
          "00:00:00.000304",
          "00:00:00.000123",
          "00:00:00.000116",
          "00:00:00.000113",
          "00:00:00.000111"
        ],
        "individualStatus": [
          true,
          true,
          true,
          true,
          true
        ],
        "interface": "Bond1G",
        "responseTime": "00:00:00.000154",
        "sourceAddressV4": "192.168.0.5",
        "successful": true
      }
    },
    "duration": "00:00:00.001747",
    "result": "Passed"
  }
}

New since version

5.0