NAME

       Smokeping::probes::OpenSSHEOSPing - Arista EOS SSH Probe for SmokePing

SYNOPSIS

        *** Probes ***

        +OpenSSHEOSPing

        forks = 5
        offset = 50%
        packetsize = 100
        step = 300
        timeout = 15

        # The following variables can be overridden in each target section
        eospass = password # mandatory
        eosuser = user # mandatory
        pings = 5
        psource = 192.168.2.129
        source = 192.168.2.1 # mandatory
        unpriv = 1

        # [...]

        *** Targets ***

        probe = OpenSSHEOSPing # if this should be the default probe

        # [...]

        + mytarget
        # probe = OpenSSHEOSPing # if the default probe is something else
        host = my.host
        eospass = password # mandatory
        eosuser = user # mandatory
        pings = 5
        psource = 192.168.2.129
        source = 192.168.2.1 # mandatory
        unpriv = 1

DESCRIPTION

       Connect to Arista EOS via OpenSSH to run ping commands.  This probe uses the "ping" cli of the Arista
       EOS.  You have the option to specify which interface the ping is sourced from as well.

VARIABLES

       Supported probe-specific variables:

       forks
           Run this many concurrent processes at maximum

           Example value: 5

           Default value: 5

       offset
           If you run many probes concurrently you may want to prevent them from hitting your network all at the
           same time. Using the probe-specific offset parameter you can change the point in time when each probe
           will be run. Offset is specified in % of total interval, or alternatively as 'random', and the offset
           from  the  'General'  section is used if nothing is specified here. Note that this does NOT influence
           the rrds itself, it is just a matter of when data acqusition is initiated.  (This  variable  is  only
           applicable if the variable 'concurrentprobes' is set in the 'General' section.)

           Example value: 50%

       packetsize
           The (optional) packetsize option lets you configure the packetsize for the pings sent.

           Default value: 100

       step
           Duration  of the base interval that this probe should use, if different from the one specified in the
           'Database' section. Note that the step in the RRD files is fixed when they are originally  generated,
           and  if  you change the step parameter afterwards, you'll have to delete the old RRD files or somehow
           convert them. (This variable is only applicable if the variable  'concurrentprobes'  is  set  in  the
           'General' section.)

           Example value: 300

       timeout
           How long a single 'ping' takes at maximum

           Example value: 15

           Default value: 5

       Supported target-specific variables:

       eospass
           The  eospass  option  allows  you  to specify the password for the username specified with the option
           eosuser.

           Example value: password

           This setting is mandatory.

       eosuser
           The eosuser option allows you to specify a username that has ping capability on the EOS Device.

           Example value: user

           This setting is mandatory.

       pings
           How many pings should be sent to each target, if different from the global  value  specified  in  the
           Database  section.  Note  that the number of pings in the RRD files is fixed when they are originally
           generated, and if you change this parameter afterwards, you'll have to delete the old  RRD  files  or
           somehow convert them.

           Example value: 5

       psource
           The  (optional)  psource option specifies an alternate IP address or Interface from which you wish to
           source your pings from.  Routers can have many many IP addresses, and interfaces.  When you ping from
           a router you have the ability to choose which interface and/or which IP address the ping  is  sourced
           from.  Specifying an IP/interface does not necessarily specify the interface from which the ping will
           leave,  but will specify which address the packet(s) appear to come from.  If this option is left out
           the EOS Device will source the packet automatically based on routing and/or metrics.  If this doesn't
           make sense to you then just leave it out.

           Example value: 192.168.2.129

       source
           The source option specifies the EOS device that is going to run the ping commands.  This address will
           be used for the ssh connection.

           Example value: 192.168.2.1

           This setting is mandatory.

       unpriv
           If the account is unprivileged, specify the 'unpriv' option.  You must also configure  "pings  =  5",
           since that is the only value supported, and values specified for packetsize or psource are ignored.

           Example value: 1

AUTHORS

       Bill Fenner <fenner@aristanetworks.com>

       based  on  Smokeping::Probes::OpenSSHJunOSPing by Tobias Oetiker <tobi@oetiker.ch>, which itself is based
       on Smokeping::probes::TelnetJunOSPing by S H A N <shanali@yahoo.com>.

NOTES

   EOS configuration
       The EOS device should have a username/password configured, and the ssh server must not be disabled.

       Make sure to connect to the remote host once from the commmand line as the user who is running smokeping.
       On the first connect ssh will ask to add the new host to its  known_hosts  file.  This  will  not  happen
       automatically  so  the  script will fail to login until the ssh key of your EOS box is in the known_hosts
       file.

   Requirements
       This module requires the  Net::OpenSSH and IO::Pty perl modules.

2.6.11                                             2015-11-26                 Smokeping_probes_OpenSSHEOSPing(3)