topology_lib_ping.library

topology_lib_ping communication library implementation.

Functions

  • ping(): Perform a ping and parse the result.
topology_lib_ping.library.ping(enode, count, destination, interval=None, quiet=False, shell=None)

Perform a ping and parse the result.

Parameters:
  • enode (topology.platforms.base.BaseNode) – Engine node to communicate with.
  • count (int) – Number of packets to send.
  • destination (str) – The destination host.
  • interval (float) – The wait interval in seconds between each packet.
  • shell (str) – Shell name to execute commands. If None, use the Engine Node default shell.
Return type:

dict

Returns:

The parsed result of the ping command in a dictionary of the form:

{
    'transmitted': 0,
    'received': 0,
    'errors': 0,
    'loss_pc': 0,
    'time_ms': 0
}