Description:
Ping the target IP address.
Can be used with Command Sequencer: No
| Attribute | Description | ||||||
|---|---|---|---|---|---|---|---|
| Common Writable Attributes | ProgressCancelled | ||||||
| DeviceList |
List of one or more host or router object handles. Tells which host or router objects will do the pinging. Type: handle Default: 0 |
||||||
| FrameCount |
How many Ping packets to transmit. Type: u32 Default: 1 |
||||||
| PingIpv4DstAddr |
Ping target IPv4 address. Type: ip Default: 0.0.0.0 |
||||||
| PingIpv4SrcAddr |
NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it. Ping source IPv4 address. You should set this to match the first IP address configured for the Ipv4If object under the host or router object, because that is the IP address that will be used as the source of the ping. Type: ip Default: 0.0.0.0 |
||||||
| PingIpv6DstAddr |
Ping target IPv6 address. Type: ipv6 Default: ::0 |
||||||
| PingIpv6SrcAddr |
NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it. Ping source IPv6 address. Type: ipv6 Default: ::0 |
||||||
| TimeInterval |
Interval in seconds between Ping packets. Type: u32 Default: 1 |
||||||
| WaitForPingToFinish |
Whether the command should wait for the Ping to finish. Type: bool Default: FALSE Possible Values:
|
| Read-Only Attribute | Description | ||||||
|---|---|---|---|---|---|---|---|
| Common Read-Only Attributes | ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status | ||||||
| PingResult |
Results of the Ping command. Type: string Default: "" (empty string) |
||||||
| PingStatus |
Whether the Ping command passed or failed. Type: bool Default: FALSE Possible Values:
|
||||||
| ProcessId |
Ping process ID. Type: u32 Default: 0 |