SolidFireElement.TestPingAsync Method (CancellationToken, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>, String, String, String, Nullable<Int64>) |
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.
Namespace:
SolidFire.Element.Api
Assembly:
SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntaxpublic Task<TestPingResult> TestPingAsync(
CancellationToken cancellationToken,
Nullable<long> Attempts = null,
string Hosts = null,
Nullable<long> TotalTimeoutSec = null,
Nullable<long> PacketSize = null,
Nullable<long> PingTimeoutMsec = null,
Nullable<bool> ProhibitFragmentation = null,
string SourceAddressV4 = null,
string SourceAddressV6 = null,
string Interface = null,
Nullable<long> VirtualNetworkTag = null
)
Parameters
- cancellationToken
- Type: System.Threading.CancellationToken
- Attempts (Optional)
- Type: System.Nullable<Int64>
- Hosts (Optional)
- Type: System.String
- TotalTimeoutSec (Optional)
- Type: System.Nullable<Int64>
- PacketSize (Optional)
- Type: System.Nullable<Int64>
- PingTimeoutMsec (Optional)
- Type: System.Nullable<Int64>
- ProhibitFragmentation (Optional)
- Type: System.Nullable<Boolean>
- SourceAddressV4 (Optional)
- Type: System.String
- SourceAddressV6 (Optional)
- Type: System.String
- Interface (Optional)
- Type: System.String
- VirtualNetworkTag (Optional)
- Type: System.Nullable<Int64>
Return Value
Type:
Task<TestPingResult>Implements
ISolidFireElement.TestPingAsync(CancellationToken, Nullable<Int64>, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>, String, String, String, Nullable<Int64>)
See Also