#!/usr/bin/env python

# Copyright (c) 2018 Arista Networks, Inc. All rights reserved.

# Arista Networks, Inc. Confidential and Proprietary.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

# - Redistributions of source code must retain the above copyright notice,

# this list of conditions and the following disclaimer.

# - Redistributions in binary form must reproduce the above copyright

# notice, this list of conditions and the following disclaimer in the

# documentation and/or other materials provided with the distribution.

# - Neither the name of Arista Networks nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

#

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS

# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR

# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN

# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#

'''

PingCheck Utility

The purpose of this utility is to test ICMP ping reachability, alert if its down and

run a config change. On recovery run another list of config changes.

Add the following configuration snippets to change the default behavior.

Current version supports a list of hosts. The host checking is a logical OR, so

only one host needs to respond. This is designed to reduce false positives.

daemon PingCheck

exec /usr/local/bin/PingCheck

option CHECKINTERVAL value 5

option CONF_FAIL value /mnt/flash/failed.conf

option CONF_RECOVER value /mnt/flash/recover.conf

option PINGCOUNT value 2

option PINGTIMEOUT value 2

option HOLDDOWN value 0

option HOLDUP value 0

option VRF value mgmt

option IPv4 value 10.1.1.1,10.1.2.1

option SOURCE value et1

no shutdown

Config Option explanation:

- CHECKINTERVAL is the time in seconds to check hosts. Default is 5 seconds.

- IPv4 is the address(s) to check. Mandatory parameter. Multiple addresses are comma separated

- CONF_FAIL is the config file to apply the snippets of config changes. Mandatory parameter.

- CONF_RECOVER is the config file to apply the snippets of config changes

after recovery of Neighbor. Mandatory parameter.

- PINGCOUNT is the number of ICMP Ping Request messages to send. Default is 2.

- HOLDDOWN is the number of iterations to wait before declaring all hosts up. Default is 0

which means take immediate action.

- HOLDUP is the number of iterations to wait before declaring all hosts down. Default is 0

which means take immediate action.

- VRF is the VRF name to use to generate the ICMP pings. If the default is used, then just leave

blank and it will use the default VRF.

- SOURCE is the source interface (as instantiated to the kernel) to generate the pings fromself.

This is optional. Default is to use RIB/FIB route to determine which interface to use as sourceself.

- PINGTIMEOUT is the ICMP ping timeout in seconds. Default value is 2 seconds.

The CONF_FAIL and CONF_RECOVER files are just a list of commands to run at either Failure or at recovery. These commands

must be FULL commands just as if you were configuration the switch from the CLI.

For example the above referenced /mnt/flash/failed.conf file could include the following commands, which would

shutdown the BGP neighbor on failure:

router bgp 65001.65500

neighbor 10.1.1.1 shutdown

The recover.conf file would do the opposite and remove the shutdown statement:

router bgp 65001.65500

no neighbor 10.1.1.1 shutdown

This is of course just an example, and your use case would determine what config changes you'd make.

Please note, because this extension uses the EOS SDK eAPI interation module, you do not need to have 'enable and 'configure'

in your config change files. This is because, the EOS SDK eAPI interation module is already in configuration mode.

'''

#************************************************************************************

# Change log

# ----------

# Version 1.0.0 - 11/2/2018 - Jeremy Georges -- jgeorges@arista.com -- Initial Version

# Version 1.2.0 - 11/9/2018 - J. Georges - Changed Source IP lookup to eAPI module. Using the socket call

# when the interface was shut down caused a core dump.

# Pinging now executed through eAPI module also. This removes the need

# for subprocess module.

# Added ping timeout option.

# Version 1.3.1 - 11/13.2018 - Merge branch changes. Change syslog to Local4 so log messages show up in EOS log

# Version 1.4.0 - 12/06/2018 - Fixed bug with startTime variable checking which could

# lead to a core dump if no fail/recover files were found.

# Added vrf support.

# Version 1.4.1 - 06/17/2020 - Fix timeout parameter for Ping command.

# Version 1.4.2 - 04/22/2021 - Added verbose error logging for applyconfig

#*************************************************************************************

#

#

#****************************

#* MODULES *

#****************************

#

import sys

import syslog

import eossdk

import os.path

import os

import simplejson

import re

import subprocess as sp

import socket

__author__ = 'Jeremy Georges'

__version__ = '1.4.2'

#***************************

#* CLASSES *

#***************************

class PingCheckAgent(eossdk.AgentHandler,eossdk.TimeoutHandler, eossdk.VrfHandler):

return 1

#=============================================

# MAIN

#=============================================

def main():

# Run the agent until terminated by a signal

if __name__ == "__main__":

main()