fetch_command_output helper (#97)

* fetch_command_output.sh tool

* Update fetch_command_update from develop (#93)

* adding read_timeout_override netmiko option

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Petr Klima <petr.klima@madeta.cz>
Co-authored-by: Dave <davama@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Anton Gridnev <anton@gridnev.pro>
This commit is contained in:
authored and GitHub committed 2024-04-23 15:06:20 +02:00
1 parent 112320f5bc
commit ce7f542df9
3 files changed
+205 -1

No files matched your search

+1 -1
View File
@@ -4,7 +4,7 @@
name: Fast Test
on:
push:
push:
branches-ignore:
- develop
- master
+47
View File
@@ -0,0 +1,47 @@
# Config file for utility 'fetch_command_output.sh'
#
# This will help you to make bunch of command output files for napalm drivers unit tests
#
# There is not any IP, MAC or names obfuscation or anonymizations!
# Before using outputs as a unit test files it is recommendet to protect
# your privacy information yourself by editing output files.
# Required variables
# $INTERFACE - for detailed interface information
# $LLDPINTERFACE - for detailed LLDP information
# Define empty array of commands
COMMANDS=()
# This is example set of commands for napalm driver 's350' (Cisco SMB)
# system info
COMMANDS+=("show version")
COMMANDS+=("show system")
COMMANDS+=("show inventory")
# config commands
COMMANDS+=("show startup-config")
COMMANDS+=("show running-config")
COMMANDS+=("show running-config detailed")
# interface commands
COMMANDS+=("show interfaces status")
COMMANDS+=("show interfaces description")
COMMANDS+=("show interface switchport $INTERFACE")
COMMANDS+=("show ports jumbo-frame")
# ip commands
COMMANDS+=("show hosts")
COMMANDS+=("show ip interface")
COMMANDS+=("show ipv6 interface brief")
COMMANDS+=("show arp")
# lldp commands
COMMANDS+=("show lldp neighbors")
COMMANDS+=("show lldp local $LLDPINTERFACE")
COMMANDS+=("show lldp neighbors $LLDPINTERFACE")
# ntp commands
COMMANDS+=("show sntp status")
+157
View File
@@ -0,0 +1,157 @@
#!/bin/bash
# Defaults
DEF_FORCE="n"
#DEF_METHOD="cli" - nice with --method-kwargs "commands=['show ip interface']"
# but output is JSON
DEF_METHOD="_send_command"
# mocked data dir
MDDIR="mocked_data"
# command output dir
CODIR="command_output"
# config
CMDIN="./$(basename $0 .sh ).cfg"
GETOPTS=":hu:p:ft:m:i:l:v:d:"
function usage() {
MSG="usage: $(basename $0) [-h] -u USERNAME -p PASSWORD [-f]\n"
MSG+=" [-m METHOD] -i INTERFACE -l LLDP_INTERFACE\n"
MSG+=" -t TYPE -v VENDOR -d DEVICE [SINGLE_COMMAND]\n"
MSG+="\n"
MSG+=" This utility helps to get output of commands from device.\n"
MSG+=" Set of commands can be configured in '$CMDIN'\n"
MSG+=" Command output is saved to '$CODIR/DEVICE_TYPE/command_out.txt'\n"
MSG+=" and by default is not to be overwriten.\n"
MSG+="\n"
MSG+=" There is not any IP, MAC or names obfuscation or anonymizations!\n"
MSG+=" Before using as a unit test files it is recommendet to protect\n"
MSG+=" your privacy information yourself by editing output files\n"
MSG+=" in '$CODIR/DEVICE_TYPE/command_out.txt'!\n"
MSG+="\n"
MSG+=" -h - this help\n"
MSG+=" -u USERNAME - login username (or env DEVUSERNAME)\n"
MSG+=" -p PASSWORD - login password (or env DEVPASSWORD)\n"
MSG+=" -f - overwrite already downloaded output files\n"
MSG+=" -t TYPE - device type\n"
MSG+=" -m METHOD - what method sends command to device (def '$DEF_METHOD')\n"
MSG+=" -i INTERFACE - interface for deailed info (see '$CMDIN')\n"
MSG+=" -l INTERFACE - interface for deailed lldp info (see '$CMDIN')\n"
MSG+=" -v VENDOR - vendor napalm driver\n"
MSG+=" -d DEVICE - device to connect\n"
[[ -n $@ ]] && echo -e "\n### $@ ###\n" >&2
echo -e "$MSG" >&2
exit 127
}
# Parse options
# No run without options
if ( ! getopts $GETOPTS opt); then # CLI bez options
usage "Options needed !!!"
fi
OPTIND=1 # reset index
# Preset defaults
FORCE="$DEF_FORCE"
METHOD="$DEF_METHOD"
while getopts $GETOPTS opt; do
#echo $opt;
case "$opt" in
'u')
DEVUSERNAME=$OPTARG ;;
'p')
DEVPASSWORD=$OPTARG ;;
't')
TYPE=$OPTARG ;;
'i')
INTERFACE=$OPTARG ;;
'l')
LLDPINTERFACE=$OPTARG ;;
'v')
VENDOR=$OPTARG ;;
'm')
METHOD=$OPTARG ;;
'd')
DEVICE=$OPTARG ;;
'f')
FORCE='y' ;;
'h')
usage ;;
':')
usage "Parameter '-$OPTARG' needs value."
;;
'?'|*)
usage "Unknown parameter '-$OPTARG' ."
;;
esac
done
# read commands from file
[ -f "$CMDIN" ] || usage "File '$CMDIN' does not exists."
[ -r "$CMDIN" ] || usage "Can not read file '$CMDIN'."
[ -z "$INTERFACE" ] && usage "Parameter -i needed"
[ -z "$LLDPINTERFACE" ] && usage "Parameter -l needed"
. "${CMDIN}"
# Get possible last arg and set it as only command
shift $(($OPTIND - 1))
[ -z "$1" ] || COMMANDS=("$1")
[ -z "$DEVUSERNAME" ] && usage "Parameter -u needed"
[ -z "$DEVPASSWORD" ] && usage "Parameter -p needed"
[ -z "$TYPE" ] && usage "Parameter -t needed"
[ -z "$VENDOR" ] && usage "Parameter -v needed"
[ -z "$DEVICE" ] && usage "Parameter -d needed"
# ensure directory structure exists
[ -d "$CODIR" ] || usage "Output directory '$CODIR' does not exist."
[ -w "$CODIR" ] || usage "Output directory '$CODIR' is not writeable."
mkdir -p "$CODIR/$TYPE" || usage "Can not make directory '$CODIR/$TYPE'"
[ -w "$CODIR/$TYPE" ] || usage "Output directory '$CODIR/$TYPE' is not writeable."
echo "########## Generate output for type $TYPE ##########"
# lets get commands outputs
OLDIFS="$IFS"
IFS=$'\t\n'
for CMD in ${COMMANDS[@]}
do
IFS="$OLDIFS"
CMDSTR=${CMD// /_}
CMDSTR=${CMDSTR//-/_}
CMDSTR=${CMDSTR/\\/_}
CMDSTR=${CMDSTR/./_}
CMDSTR=${CMDSTR////_}
CMDFILE="$CODIR/$TYPE/${CMDSTR}.txt"
# skip already fetched command outputs
if [ -f "$CMDFILE" -a "$FORCE" = "n" ]; then
echo "###### Skiping '$CMD'. File '$CMDFILE' exists"
continue
fi
echo "## Fetching '$CMD' to '$CMDSTR.txt'"
# --debug
echo -e "$(napalm --user "$DEVUSERNAME" --password "$DEVPASSWORD" --vendor "$VENDOR" "$DEVICE" call --method-kwargs "command='$CMD'" "$METHOD" | sed 's/^"//;s/"$//;s/\\"/"/g')" > "$CMDFILE"
done