TestPingRequest Class |
TestPingRequest
The TestPing API allows to test the reachability to IP address(s) using ICMP packets. Source address(v4 or v6), interface and vlan tag can be specified. If not Bond1G/10G network is used to reach the target address.
The test uses the appropriate MTU sizes for each packet based on the MTU settings in the network configuration.
Note: This method is available only through the per-node API endpoint 5.0 or later.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class TestPingRequest : RpcBase
The TestPingRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TestPingRequest | Initializes a new instance of the TestPingRequest class |
Properties| Name | Description | |
|---|---|---|
 | Attempts |
Specifies the number of times the system
should repeat the test ping. The default value is 5.
|
| Hosts |
Specifies a comma-separated list of addresses or hostnames of devices to ping.
|
| Interface |
Existing interface on which the temporary vlan interface is created
|
| PacketSize |
Specifies the number of bytes to send in the ICMP packet that is sent to each IP. The number must be less than the maximum MTU specified in the network configuration.
|
| PingTimeoutMsec |
Specifies the number of milliseconds to wait for each individual ping response. The default value is 500 ms.
|
| ProhibitFragmentation |
Specifies that the Do not Fragment (DF) flag is enabled for the ICMP packets.
|
| SourceAddressV4 |
The ipv4 source address to be used in the ICMP ping packets
sourceAddressV4 or sourceAddressV6 is required
|
| SourceAddressV6 |
The ipv6 source address to be used in the ICMP ping packets
sourceAddressV4 or sourceAddressV6 is required
|
| TotalTimeoutSec |
Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process.
|
| VirtualNetworkTag |
VLAN on which host addresses reachability needs to be tested
The temporary vlan interface is created with this tag
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.) |
See Also