eos_ping

Synopsis

Added in version 1.0.0

The eos_ping module will execute a network ping from the node and return the results. If the destination can be successfully pinged, then the module returns successfully. If any of the sent pings are not returned the module fails. By default, the error threshold is set to the same value as the number of pings sent

Options

parameter required default choices comments
count no 5
    		Configures the number of packets to send from the node to the remote dst. The default value is 5.
    (added in 1.1.0)
    dst yes
      		Specifies the destination IP address or FQDN for the network ping packet.
      (added in 1.1.0)
      error_threshold no
        		Configures the error threshold (in packet loss percentage) for the ping test to be considered failed. By default the value of the error_threshold is set to 0. Valid values between 0 and 100.
        (added in 1.1.0)
        source no
          		Configures the source interface for the network ping packet
          (added in 1.1.0)

          Important

          Requires Arista EOS 4.13.7M or later with command API enabled

          Important

          Requires Python Client for eAPI 0.4.0 or later

          Examples


          - eos_ping: dst=192.168.1.254 count=10

# Set the error_threshold to 50% packet loss
- eos_ping: dst=192.168.1.254 count=10 error_threshold=50

          Note

          Important fixes to this module were made in pyeapi 0.4.0. Be sure to update to at least that version.

          Note

          All configuration is idempotent unless otherwise specified

          Note

          Supports eos metaparameters for using the eAPI transport

          Note

          Does not support stateful resource configuration.