CheckPingOnVlan
Suggest changes
PDFs
You can use the CheckPingOnVlan method to test network connectivity on a temporary VLAN when performing pre-deployment network validation. CheckPingOnVlan creates a temporary VLAN interface, sends ICMP packets to all nodes in the storage cluster using the VLAN interface, and then removes the 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. |
string |
The nodes in the cluster |
No |
interface |
The existing (base) interface from which the pings should be sent. Possible values:
|
string |
None |
Yes |
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 |
sourceAddressV4 |
The source IPv4 address to use in the ICMP ping packets. |
string |
None |
Yes |
sourceAddressV6 |
The source IPv6 address to use in the ICMP ping packets. |
string |
None |
Yes |
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 |
Yes |
Return values
This method has the following return values:
Name |
Description |
Type |
result |
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": "CheckPingOnVlan",
"params": {
"interface": "Bond10G",
"virtualNetworkTag": 4001,
"sourceAddressV4": "192.168.41.4",
"hosts": "192.168.41.2"
},
"id": 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result": {
"192.168.41.2": {
"individualResponseCodes": [
"Success",
"Success",
"Success",
"Success",
"Success"
],
"individualResponseTimes": [
"00:00:00.000373",
"00:00:00.000098",
"00:00:00.000097",
"00:00:00.000074",
"00:00:00.000075"
],
"individualStatus": [
true,
true,
true,
true,
true
],
"interface": "Bond10G",
"responseTime": "00:00:00.000143",
"sourceAddressV4": "192.168.41.4",
"successful": true,
"virtualNetworkTag": 4001
}
}
}
New since version
11.1