├── .gitignore ├── Example_Scripts ├── Cisco │ ├── FixNTPandLog.py │ ├── RADIUSChange.py │ ├── TFTP_backups.py │ ├── auditQOS.py │ ├── automatedtftpBackups.py │ ├── convert_snmp_v2c.py │ ├── enumSwitchType.py │ ├── ephoneChange.py │ ├── findMAC.py │ ├── ismyclockokay.py │ └── shCDPneigh.py ├── Fortigate │ ├── Bypass_Report.py │ ├── blacklist_fortinet.py │ └── fortiport.py ├── TinyDB │ ├── dbInputData.py │ ├── dbquery.py │ ├── populateTinyDB.py │ └── qdb.py └── Utilities │ ├── convencoding.py │ ├── fixCSV.py │ ├── formatCW.py │ ├── get_dns_records.py │ └── multitest.py ├── LICENSE ├── PythonLinks.md ├── README.md ├── credentials.py ├── exampleCSV.md ├── netspark.py ├── spark_single.py └── spark_threaded.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | .static_storage/ 56 | .media/ 57 | local_settings.py 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # Other Files # 107 | ############### 108 | *.csv 109 | *.json 110 | *.txt 111 | *.pdf 112 | *.ini 113 | *.xlsx -------------------------------------------------------------------------------- /Example_Scripts/Cisco/FixNTPandLog.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script will modify te NTP and logging sections. Needs improvement (like 4 | checks and such...) 5 | ------------------------------------------------------------------------------- 6 | ''' 7 | 8 | from datetime import datetime 9 | import csv 10 | from multiprocessing.dummy import Pool as ThreadPool 11 | from netmiko import ConnectHandler 12 | import configparser 13 | import credentials # Local import of credentials.py 14 | 15 | 16 | STARTTIME = datetime.now() # Begin timing the script 17 | 18 | config = configparser.ConfigParser() 19 | config.read("netsparkconfig.ini") 20 | NTPSERVER = "ntp server " + config.get("companystd", "ntp_server") 21 | OLDNTPSERVER = "no ntp server " + config.get("companystd", "old_ntp_server") 22 | TIMEZONE = "clock summer-time " + config.get("companystd", "timezone") + " recurring" 23 | LOGSERVER = "logging host " + config.get("companystd", "log_server") + " transport udp port " + config.get("companystd", "logsrv_port") 24 | 25 | CUSTOMER = input("Which file? ") + ".csv" 26 | USERNAME, PASSWORD, SECRET = credentials.cred_csv() 27 | POOL = ThreadPool() 28 | 29 | 30 | def generate_ip_list(custdictionary): 31 | '''Return a list of IP's from the dictionary''' 32 | ip_list = [d['IP_Address'] for d in custdictionary if 'IP_Address' in d] 33 | return ip_list 34 | 35 | 36 | def generate_cust_dict(customer): 37 | '''Generates a dictionary from the customer data csv file''' 38 | with open(customer, mode='r') as csvfile: 39 | reader = csv.DictReader(csvfile) 40 | data = [] 41 | for line in reader: 42 | data.append(line) 43 | return data 44 | 45 | 46 | def find_by_ip(lst, value): 47 | '''Returns the row that a specific IP is in (search for row by IP''' 48 | for row in lst: 49 | if str(row['IP_Address']) == str(value): 50 | return row 51 | 52 | 53 | def generate_switch_dict(username, password, secret, matchrow): 54 | '''Makes the switch dictionary for Netmiko's connection handler''' 55 | switch = { 56 | 'device_type': matchrow['device_type'], 57 | 'ip': matchrow['IP_Address'], 58 | 'username': username, 59 | 'password': password, 60 | 'secret': secret, 61 | 'verbose': False, 62 | } 63 | return switch 64 | 65 | 66 | def switch_run_command(ipaddr): 67 | '''All the logic happens here. Take the data, process it, print results''' 68 | matchrow = find_by_ip(CUSTDICTIONARY, ipaddr) 69 | sessiondict = generate_switch_dict(USERNAME, PASSWORD, SECRET, matchrow) 70 | session = ConnectHandler(**sessiondict) 71 | session.enable() 72 | hostname = matchrow['SysName'] 73 | # ----------NTP------------- 74 | ntp_settings = [OLDNTPSERVER, 75 | NTPSERVER, 76 | 'no clock summer-time', 77 | TIMEZONE, 78 | 'service timestamps log datetime localtime show-timezone', 79 | 'service timestamps debug datetime localtime show-timezone'] 80 | 81 | session.send_config_set(ntp_settings) 82 | #----------logging----------- 83 | log_settings = ['logging trap notifications', 84 | 'logging facility syslog', 85 | LOGSERVER] 86 | session.send_config_set(log_settings) 87 | #----------------------------- 88 | resultsntp = session.send_command("sh run | in ntp|timezone|clock") 89 | resultslog = session.send_command("sh run | in logging") 90 | # Fancy formatting here for results 91 | print("\n\n>>>>>>>>> {0} {1} <<<<<<<<<\n".format(hostname, ipaddr) 92 | + resultsntp 93 | + "\n\n" 94 | + resultslog 95 | + "\n>>>>>>>>> End <<<<<<<<<\n") 96 | # Disconnect the netmiko session 97 | session.disconnect() 98 | 99 | 100 | CUSTDICTIONARY = generate_cust_dict(CUSTOMER) 101 | IP_LIST = generate_ip_list(CUSTDICTIONARY) 102 | 103 | RESULTS = POOL.map(switch_run_command, IP_LIST) 104 | 105 | POOL.close() 106 | POOL.join() 107 | 108 | ENDTIME = datetime.now() 109 | TOTALTIME = ENDTIME - STARTTIME 110 | print("\nTotal time for script: \n" + str(TOTALTIME)) 111 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/RADIUSChange.py: -------------------------------------------------------------------------------- 1 | #Global imports 2 | from netmiko import ConnectHandler 3 | from datetime import datetime 4 | import csv, os.path 5 | #Local imports 6 | import credentials 7 | 8 | # Begin timing the script 9 | start_time = datetime.now() 10 | 11 | # Define the primary function (to be moved to a separate module some day...) 12 | def nc(username, password, secret, customer, radiuskey, radiusserver, radiusgroupname, ticketnum): 13 | with open(customer, mode='r') as csvfile: 14 | reader = csv.DictReader(csvfile) 15 | # Now iterate through every row in the CSVfile and make dictionaries 16 | for row in reader: 17 | hostname = row['SysName'] 18 | device_type = row['device_type'] 19 | ip = row['IP_Address'] 20 | switch = { 21 | 'device_type': device_type, 22 | 'ip': ip, 23 | 'username': username, 24 | 'password': password, 25 | 'secret': secret, 26 | 'verbose': False, 27 | } 28 | # This is your connection handler for commands from here on out 29 | net_connect = ConnectHandler(**switch) 30 | # Insert your commands here 31 | net_connect.enable() 32 | net_connect.send_command('send log "Beginning change ticket {}"'.format(ticketnum)) 33 | aaanewmodel = net_connect.send_command('sh run | inc aaa new-model') 34 | oldradiusserver = net_connect.send_command('sh run | inc radius-server') 35 | oldaaaauth = net_connect.send_command('sh run | inc aaa authentication') 36 | oldVTYauth = net_connect.send_command('sh run | inc line vty|login authentication') 37 | oldgroup = net_connect.send_command('sh run | inc aaa group server radius ' + radiusgroupname) 38 | 39 | # or maybe send configuration stuff with 40 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 41 | # Now make it pretty 42 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<".format(row['SysName'])) 43 | print("\n---------- Original Configuration ----------") 44 | print(aaanewmodel) 45 | print(oldradiusserver) 46 | print(oldaaaauth) 47 | print(oldVTYauth) 48 | if oldgroup != "": 49 | print(oldgroup) 50 | print("---------- Modified Configuration ------------\n") 51 | if aaanewmodel == "" or aaanewmodel == "no aaa new-model": 52 | net_connect.send_config_set('aaa new-model') 53 | print("New AAA model enabled on device") 54 | if oldgroup == "": 55 | config_radgroup = [ 'aaa group server radius ' + str(radiusgroupname), 56 | 'server-private ' + str(radiusserver) + ' auth-port 1812 acct-port 1813 key ' + radiuskey, 57 | 'exit', 58 | 'aaa authentication login VTY local group ' + str(radiusgroupname), 59 | 'end' ] 60 | net_connect.send_config_set(config_radgroup) 61 | #print config_radgroup 62 | print("AAA Group " + str(radiusgroupname) + " at IP " + str(radiusserver) + " configured on device") 63 | else: 64 | print("AAA group already configured on device") 65 | print("\n>>>>>>>>> End <<<<<<<<<") 66 | net_connect.send_command('send log "Completing change ticket {}"'.format(ticketnum)) 67 | # Disconnect from this session 68 | net_connect.disconnect() 69 | 70 | # Grab the Customer name to search 71 | customer = input('Customer name: ') + ".csv" 72 | # Enter ticket number for SW change logging 73 | ticketnum = input('Ticket #: ') 74 | # Ask for the RADIUS key you want to username 75 | radiuskey = input('Enter the RADIUS key for authentication: ') 76 | # And the RADIUS server 77 | radiusserver = input('Enter the RADIUS server: ') 78 | # And your group name! (seriously just take all this from config) 79 | radiusgroupname = input('Enter the RADIUS group-name: ') 80 | # Flesh out these variables using the credentials.cred_csv module 81 | username, password, secret = credentials.cred_csv() 82 | # Give it a command: 83 | # command_string = "write mem" # can be passed to nc... 84 | # Run the primary function in this program 85 | nc(username, password, secret, customer, radiuskey, radiusserver, radiusgroupname, ticketnum) 86 | 87 | # Script does the needful.... 88 | 89 | end_time = datetime.now() 90 | # How long did it run? 91 | total_time = end_time - start_time 92 | print("\nTotal time for script: \n" + str(total_time)) 93 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/TFTP_backups.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This program will back up the current running configuration to the TFTP server 3 | of your choice. Honestly, you should use SFTP or SCP but, here we are. 4 | ''' 5 | 6 | #Global imports 7 | from datetime import datetime 8 | import csv 9 | import configparser 10 | from netmiko import ConnectHandler 11 | #Local imports 12 | import credentials 13 | 14 | # Begin timing the script 15 | STARTTIME = datetime.now() 16 | 17 | config = configparser.ConfigParser() 18 | config.read("netsparkconfig.ini") 19 | tftpserver = config.get("tftpinfo", "tftpserver") 20 | 21 | # Define the primary function (to be moved to a separate module some day...) 22 | def netcon(username, password, secret, CUSTOMER): 23 | ''' 24 | This is the core function. Iterates through a CSV, forms a dict, runs the command 25 | and logics it. 26 | ''' 27 | with open(CUSTOMER, mode='r') as csvfile: 28 | reader = csv.DictReader(csvfile) 29 | # Now iterate through every row in the CSVfile and make dictionaries 30 | for row in reader: 31 | hostname = row['SysName'] 32 | device_type = row['device_type'] 33 | ipaddr = row['IP_Address'] 34 | switch = { 35 | 'device_type': device_type, 36 | 'ip': ipaddr, 37 | 'username': username, 38 | 'password': password, 39 | 'secret': secret, 40 | 'verbose': False, 41 | } 42 | # This is your connection handler for commands from here on out 43 | net_connect = ConnectHandler(**switch) 44 | # Insert your commands here 45 | net_connect.enable() 46 | COMMANDSTRING = "copy running-config tftp://" + tftpserver + "/" + hostname + "-" + TODAYDATE + ".txt" 47 | config_archive = [ 'file prompt quiet' ] 48 | net_connect.send_config_set(config_archive) 49 | checkbackup = net_connect.send_command(COMMANDSTRING) 50 | fix_archive = [ 'file prompt alert' ] 51 | net_connect.send_config_set(fix_archive) 52 | 53 | # Now make it pretty 54 | print("\n\n>>>>>>>>> Device {0} {1} <<<<<<<<<".format(hostname, ipaddr)) 55 | print(checkbackup) 56 | print("\n>>>>>>>>> End <<<<<<<<<") 57 | # Disconnect from this session 58 | net_connect.disconnect() 59 | 60 | # Grab the Customer name to search 61 | CUSTOMER = input('Customer name: ') + ".csv" 62 | # Flesh out these variables using the credentials.cred_csv module 63 | username, password, secret = credentials.cred_csv() 64 | # Just for testing 65 | # COMMANDSTRING = input('Command string to run: ') 66 | TODAYDATE = str(datetime.now().date()) 67 | # Run the primary function in this program 68 | netcon(username, password, secret, CUSTOMER) 69 | 70 | 71 | ENDTIME = datetime.now() 72 | # How long did it run? 73 | TOTALTIME = ENDTIME - STARTTIME 74 | print("\nTotal time for script: \n" + str(TOTALTIME)) 75 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/auditQOS.py: -------------------------------------------------------------------------------- 1 | #Global imports 2 | from netmiko import ConnectHandler 3 | from datetime import datetime 4 | import csv, os.path 5 | #Local imports 6 | import credentials 7 | 8 | # Begin timing the script 9 | start_time = datetime.now() 10 | 11 | # Define the primary function (to be moved to a separate module some day...) 12 | def nc(username, password, secret, customer): 13 | with open(customer, mode='r') as csvfile: 14 | reader = csv.DictReader(csvfile) 15 | # Now iterate through every row in the CSVfile and make dictionaries 16 | for row in reader: 17 | hostname = row['SysName'] 18 | device_type = row['device_type'] 19 | ip = row['IP_Address'] 20 | switch = { 21 | 'device_type': device_type, 22 | 'ip': ip, 23 | 'username': USERNAME, 24 | 'password': PASSWORD, 25 | 'secret': SECRET, 26 | 'verbose': False, 27 | } 28 | # This is your connection handler for commands from here on out 29 | net_connect = ConnectHandler(**switch) 30 | # Insert your commands here 31 | net_connect.enable() 32 | # or maybe send configuration stuff with 33 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 34 | connect_return = net_connect.send_command("sh mls qos") 35 | # Now make it pretty 36 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<".format(hostname)) 37 | print(connect_return) 38 | print("\n>>>>>>>>> End <<<<<<<<<") 39 | # Disconnect from this session 40 | net_connect.disconnect() 41 | 42 | # Grab the Customer name to search 43 | CUSTOMER = input('Customer name: ') + ".csv" 44 | # Flesh out these variables using the credentials.cred_csv module 45 | USERNAME, PASSWORD, SECRET = credentials.cred_csv() 46 | # Give it a command: 47 | # command_string = "write mem" # can be passed to nc... 48 | # Run the primary function in this program 49 | nc(USERNAME, PASSWORD, SECRET, CUSTOMER) 50 | 51 | 52 | end_time = datetime.now() 53 | # How long did it run? 54 | total_time = end_time - start_time 55 | print("\nTotal time for script: \n" + str(total_time)) 56 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/automatedtftpBackups.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This script will verify TFTP backups on switches and remediate if 3 | it's not working properly. 4 | ''' 5 | 6 | 7 | 8 | #Global imports 9 | from netmiko import ConnectHandler 10 | from datetime import datetime 11 | import csv, os.path 12 | #Local imports 13 | import credentials 14 | 15 | start_time = datetime.now() 16 | 17 | def backups(username, password, secret, customer, tftp_ip): 18 | with open(customer, mode='r') as csvfile: 19 | reader = csv.DictReader(csvfile) 20 | 21 | for row in reader: 22 | hostname = row['SysName'] 23 | device_type = row['device_type'] 24 | ip = row['IP_Address'] 25 | switch = { 26 | 'device_type': device_type, 27 | 'ip': ip, 28 | 'username': username, 29 | 'password': password, 30 | 'secret': secret, 31 | 'verbose': False, 32 | } 33 | 34 | net_connect = ConnectHandler(**switch) 35 | 36 | # Insert enables et al here 37 | net_connect.enable() 38 | 39 | # Temporary variable, need raw input later 40 | change_number = "1" 41 | # Then command strings 42 | net_connect.send_command('send log "Starting change ticket {}"'.format(change_number)) 43 | iphost = net_connect.send_command("sh run | inc ip host tftp") 44 | archive = net_connect.send_command("sh run | inc archive") 45 | kronpolicy = net_connect.send_command("sh run | inc kron policy-list BACKUP-CONFIG") 46 | kronoccur = net_connect.send_command("sh run | inc kron occurrence DAILY-CONFIG-BACKUP") 47 | 48 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<\n".format(row['SysName'])) 49 | if iphost == "": 50 | net_connect.config_mode() 51 | ipcommand = "ip host tftp " + str(tftp_ip) 52 | net_connect.send_command_expect(ipcommand) 53 | print("Configured TFTP IP to " + str(tftp_ip)) 54 | else: 55 | print("TFTP IP is already configured to " + str(iphost)) 56 | if archive == "": 57 | config_archive = [ 'archive', 58 | 'path tftp://tftp/$h/$h', 59 | 'write-memory', 60 | 'exit' ] 61 | net_connect.send_config_set(config_archive) 62 | print("Archive now configured.") 63 | else: 64 | print("Archive already configured.") 65 | if kronpolicy == "": 66 | config_kronp = [ 'kron policy-list BACKUP-CONFIG', 67 | 'cli write memory', 68 | 'exit' ] 69 | net_connect.send_config_set(config_kronp) 70 | print("Kron Policy BACKUP-CONFIG now configured.") 71 | else: 72 | print("Kron Policy BACKUP-CONFIG already configured.") 73 | if kronoccur == "": 74 | config_krono = [ 'kron occurrence DAILY-CONFIG-BACKUP at 0:05 recurring', 75 | 'policy-list BACKUP-CONFIG', 76 | 'exit'] 77 | net_connect.send_config_set(config_krono) 78 | print("Kron Occurrence DAILY-CONFIG-BACKUP now configured.") 79 | else: 80 | print("Kron Occurrence DAILY-CONFIG-BACKUP already configured.") 81 | net_connect.send_command_expect('write memory') 82 | print("Memory Saved.") 83 | net_connect.send_command('send log "Completing change ticket {}"'.format(change_number)) 84 | print("\n>>>>>>>>> End <<<<<<<<<") 85 | # Disconnect from this session 86 | net_connect.disconnect() 87 | 88 | # Grab the Customer name to search 89 | customer = input('Customer name: ') + ".csv" 90 | # Grab the IP of the TFTP server to be sets 91 | tftp_ip = input('TFTP server IP: ') 92 | # tftp_ip = "10.69.1.15" 93 | # Flesh out these variables using the credentials.cred_csv module 94 | username, password, secret = credentials.cred_csv() 95 | # Run the primary function in this program 96 | backups(username, password, secret, customer, tftp_ip) 97 | 98 | end_time = datetime.now() 99 | # How long did it run? 100 | total_time = end_time - start_time 101 | print("\nTotal time for script: \n" + str(total_time)) 102 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/convert_snmp_v2c.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script is a baseline for multithreaded conversion of all of the scripts. 4 | I'll look into converting the repo to use multithread, some day. 5 | ------------------------------------------------------------------------------- 6 | ''' 7 | 8 | from datetime import datetime 9 | import csv 10 | import configparser 11 | from multiprocessing.dummy import Pool as ThreadPool 12 | from netmiko import ConnectHandler 13 | import credentials # Local import of credentials.py 14 | 15 | 16 | STARTTIME = datetime.now() # Begin timing the script 17 | 18 | config = configparser.ConfigParser() 19 | config.read("netsparkconfig.ini") 20 | OLDCOMM = config.get("snmpinfo", "oldcomm") 21 | ACLNUM = config.get("snmpinfo", "aclnum") 22 | SNMPSERV = config.get("snmpinfo", "snmpserv") 23 | V2CCOMM = config.get("snmpinfo", "v2ccomm") 24 | CONTACT = config.get("snmpinfo", "contact") 25 | LOCATION = config.get("snmpinfo", "location") 26 | 27 | USERNAME, PASSWORD, SECRET = credentials.cred_csv() 28 | COMMAND = [ 'no ip access-list standard snmplist', 29 | 'no snmp-server community ' + OLDCOMM, 30 | 'ip access-list standard ' + ACLNUM, 31 | 'no 10', 32 | 'no 20', 33 | '10 permit host ' + SNMPSERV + ' log', 34 | '20 deny any log', 35 | 'exit', 36 | 'snmp-server community ' + V2CCOMM + ' ro 10', 37 | 'snmp-server contact ' + CONTACT, 38 | 'snmp-server location ' + LOCATION ] 39 | 40 | CUSTOMER = input("Which customer? ") + ".csv" 41 | POOL = ThreadPool() 42 | 43 | 44 | def generate_ip_list(custdictionary): 45 | '''Return a list of IP's from the dictionary''' 46 | ip_list = [d['IP_Address'] for d in custdictionary if 'IP_Address' in d] 47 | return ip_list 48 | 49 | 50 | def generate_cust_dict(customer): 51 | '''Generates a dictionary from the customer data csv file''' 52 | with open(customer, mode='r') as csvfile: 53 | reader = csv.DictReader(csvfile) 54 | data = [] 55 | for line in reader: 56 | data.append(line) 57 | return data 58 | 59 | 60 | def find_by_ip(lst, value): 61 | '''Returns the row that a specific IP is in (search for row by IP''' 62 | for row in lst: 63 | if str(row['IP_Address']) == str(value): 64 | return row 65 | 66 | 67 | def generate_switch_dict(username, password, secret, matchrow): 68 | '''Makes the switch dictionary for Netmiko's connection handler''' 69 | switch = { 70 | 'device_type': matchrow['device_type'], 71 | 'ip': matchrow['IP_Address'], 72 | 'username': username, 73 | 'password': password, 74 | 'secret': secret, 75 | 'verbose': False, 76 | } 77 | return switch 78 | 79 | 80 | def switch_run_command(ipaddr): 81 | '''All the logic happens here. Take the data, process it, print results''' 82 | matchrow = find_by_ip(CUSTDICTIONARY, ipaddr) 83 | sessiondict = generate_switch_dict(USERNAME, PASSWORD, SECRET, matchrow) 84 | session = ConnectHandler(**sessiondict) 85 | session.enable() 86 | session.send_config_set(COMMAND) 87 | session_return = session.send_command('show run | in snmp') 88 | hostname = matchrow['SysName'] 89 | # Fancy formatting here for results 90 | print("\n\n>>>>>>>>> {0} {1} <<<<<<<<<\n".format(hostname, ipaddr) 91 | + session_return 92 | + "\n>>>>>>>>> End <<<<<<<<<\n") 93 | # Disconnect the netmiko session 94 | session.disconnect() 95 | 96 | 97 | CUSTDICTIONARY = generate_cust_dict(CUSTOMER) 98 | IP_LIST = generate_ip_list(CUSTDICTIONARY) 99 | 100 | RESULTS = POOL.map(switch_run_command, IP_LIST) 101 | 102 | POOL.close() 103 | POOL.join() 104 | 105 | ENDTIME = datetime.now() 106 | TOTALTIME = ENDTIME - STARTTIME 107 | print("\nTotal time for script: \n" + str(TOTALTIME)) 108 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/enumSwitchType.py: -------------------------------------------------------------------------------- 1 | #Global imports 2 | from netmiko import ConnectHandler 3 | from datetime import datetime 4 | import csv, os.path 5 | #Local imports 6 | import credentials 7 | 8 | # Begin timing the script 9 | start_time = datetime.now() 10 | 11 | # Define the primary function (to be moved to a separate module some day...) 12 | def enumSwitch(username, password, secret, customer): 13 | with open(customer, mode='r') as csvfile: 14 | reader = csv.DictReader(csvfile) 15 | # Now iterate through every row in the CSVfile and make dictionaries 16 | for row in reader: 17 | hostname = row['SysName'] 18 | device_type = row['device_type'] 19 | ip = row['IP_Address'] 20 | switch = { 21 | 'device_type': device_type, 22 | 'ip': ip, 23 | 'username': username, 24 | 'password': password, 25 | 'secret': secret, 26 | 'verbose': False, 27 | } 28 | # This is your connection handler for commands from here on out 29 | net_connect = ConnectHandler(**switch) 30 | # Insert your commands here 31 | # net_connect.enable() 32 | # or maybe send configuration stuff with 33 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 34 | modelnum = "show version | include Model number" 35 | firmware = "show version | include flash:" 36 | modelnumret = net_connect.send_command(modelnum) 37 | firmwareret = net_connect.send_command(firmware) 38 | # Now make it pretty 39 | print("\n\n>>>>>>>>> Device {0} {1} <<<<<<<<<".format(row['SysName'], ip)) 40 | print(modelnumret) 41 | print(firmwareret) 42 | print("\n>>>>>>>>> End <<<<<<<<<") 43 | # Disconnect from this session 44 | net_connect.disconnect() 45 | 46 | # Grab the Customer name to search 47 | customer = input('Customer name: ') + ".csv" 48 | # Flesh out these variables using the credentials.cred_csv module 49 | username, password, secret = credentials.cred_csv() 50 | # Give it a command: 51 | # command_string = "write mem" # can be passed to nc... 52 | # Run the primary function in this program 53 | enumSwitch(username, password, secret, customer) 54 | 55 | 56 | end_time = datetime.now() 57 | # How long did it run? 58 | total_time = end_time - start_time 59 | print("\nTotal time for script: \n" + str(total_time)) 60 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/ephoneChange.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script is an example of making changes on a CUCME/CUBE box, which is 4 | just a router with special options enabled. 5 | ------------------------------------------------------------------------------- 6 | ''' 7 | 8 | #Global imports 9 | from netmiko import ConnectHandler 10 | from datetime import datetime 11 | import csv, os.path 12 | #Local imports 13 | import credentials 14 | 15 | # Begin timing the script 16 | start_time = datetime.now() 17 | 18 | # Define the primary function (to be moved to a separate module some day...) 19 | def nc(username, password, secret, customercsv, i): 20 | with open(customercsv, mode='r') as csvfile: 21 | reader = csv.DictReader(csvfile) 22 | # Now iterate through every row in the CSVfile and make dictionaries 23 | for row in reader: 24 | hostname = row['SysName'] 25 | device_type = row['device_type'] 26 | ip = row['IP_Address'] 27 | switch = { 28 | 'device_type': device_type, 29 | 'ip': ip, 30 | 'username': username, 31 | 'password': password, 32 | 'secret': secret, 33 | 'verbose': False, 34 | } 35 | # This is your connection handler for commands from here on out 36 | net_connect = ConnectHandler(**switch) 37 | # Now make it pretty 38 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<\n".format(row['SysName'])) 39 | # Enable mode 40 | net_connect.enable() 41 | # Here's the commands to be run in config mode 42 | fix_call_waiting = [i, 43 | 'no call-waiting beep', 44 | 'exit'] 45 | # Send the fix 46 | net_connect.send_config_set(fix_call_waiting) 47 | # Make sure it's applied 48 | verify_config = "show run | beg {0}".format(i) 49 | con_ret = net_connect.send_command(verify_config) 50 | # Formatted to match all text before the first '!', due to sh run sucking hard 51 | print(con_ret.partition("!")[0]) 52 | # Now let everyone else know we're doing things (ELK is working, right?) 53 | sendlog = str('send log 0 "Added no call-waiting beep to {}"').format(i) 54 | net_connect.send_command(sendlog) 55 | print("\n>>>>>>>>> End <<<<<<<<<") 56 | # Disconnect from this session 57 | net_connect.disconnect() 58 | 59 | # Grab the Customer name to search 60 | customer = input('Customer name: ') 61 | customercsv = str(customer) + ".csv" 62 | ephone = str(customer) + "-ephone.txt" 63 | # Flesh out these variables using the credentials.cred_csv module 64 | username, password, secret = credentials.cred_csv() 65 | # Run the primary function in this program 66 | with open(ephone, 'r') as inputfile: 67 | data=inputfile.readlines() 68 | for i in data: 69 | nc(username, password, secret, customercsv, i) 70 | 71 | # Stop time! 72 | end_time = datetime.now() 73 | # How long did it run? 74 | total_time = end_time - start_time 75 | print("\nTotal time for script: \n" + str(total_time)) 76 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/findMAC.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This Script will log in to multiple devices, search their 4 | MAC address tables, and spit out the ports those MAC's are 5 | found on with the switch name. The idea is that it will 6 | assist in finding the correct port for phones and other things. 7 | ------------------------------------------------------------------------------- 8 | ''' 9 | 10 | #Global imports 11 | from netmiko import ConnectHandler 12 | from datetime import datetime 13 | import csv, os.path 14 | #Local imports 15 | import credentials 16 | 17 | start_time = datetime.now() 18 | 19 | def findmac(username, password, secret): 20 | with open(customer, mode='r') as csvfile: 21 | reader = csv.DictReader(csvfile) 22 | macAddr = input('MAC of the device in cisco format: ') 23 | 24 | command_string_mac = 'show mac add | inc ' + str(macAddr) 25 | command_string_cdp = 'show cdp neigh | inc ' + str(macAddr) 26 | 27 | for row in reader: 28 | hostname = row['SysName'] 29 | device_type = row['device_type'] 30 | ip = row['IP_Address'] 31 | switch = { 32 | 'device_type': device_type, 33 | 'ip': ip, 34 | 'username': username, 35 | 'password': password, 36 | 'secret': secret, 37 | 'verbose': False, 38 | } 39 | 40 | net_connect = ConnectHandler(**switch) 41 | net_connect.enable() 42 | macreturn = net_connect.send_command(command_string_mac) 43 | cdpreturn = net_connect.send_command(command_string_cdp) 44 | 45 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<".format(row['SysName'])) 46 | print("\nMAC Address Hits on this switch: ") 47 | print(macreturn) 48 | print("\nCisco Discovery Protocol Hits on this switch: ") 49 | if cdpreturn == "": 50 | print("No CDP results for this MAC") 51 | else: 52 | print(cdpreturn) 53 | cdplist = ' '.join(macreturn.split()) 54 | port = cdplist.split(' ')[3] 55 | command_string_port = 'show run int ' + str(port) 56 | portreturn = net_connect.send_command(command_string_port) 57 | print("\nPort Configuration for matched CDP: ") 58 | print(portreturn) 59 | print("\n>>>>>>>>> End <<<<<<<<<") 60 | 61 | net_connect.disconnect() 62 | 63 | # Grab the Customer name to search 64 | customer = input('Customer name: ') + ".csv" 65 | # Flesh out these variables using the credentials.cred_csv module 66 | username, password, secret = credentials.cred_csv() 67 | # Run the primary function in this program 68 | findmac(username, password, secret) 69 | 70 | end_time = datetime.now() 71 | # How long did it run? 72 | total_time = end_time - start_time 73 | print("\nTotal time for script: \n" + str(total_time)) 74 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/ismyclockokay.py: -------------------------------------------------------------------------------- 1 | #Global imports 2 | from netmiko import ConnectHandler 3 | from datetime import datetime 4 | import csv, os.path 5 | #Local imports 6 | import credentials 7 | 8 | # Begin timing the script 9 | start_time = datetime.now() 10 | 11 | # Define the primary function (to be moved to a separate module some day...) 12 | def nc(username, password, secret, customer): 13 | with open(customer, mode='r') as csvfile: 14 | reader = csv.DictReader(csvfile) 15 | # Now iterate through every row in the CSVfile and make dictionaries 16 | for row in reader: 17 | hostname = row['SysName'] 18 | device_type = row['device_type'] 19 | ip = row['IP_Address'] 20 | switch = { 21 | 'device_type': device_type, 22 | 'ip': ip, 23 | 'username': username, 24 | 'password': password, 25 | 'secret': secret, 26 | 'verbose': False, 27 | } 28 | # This is your connection handler for commands from here on out 29 | net_connect = ConnectHandler(**switch) 30 | # Insert your commands here 31 | net_connect.enable() 32 | # or maybe send configuration stuff with 33 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 34 | connect_return = net_connect.send_command("show inv | in PID") 35 | # Now make it pretty 36 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<".format(row['SysName'])) 37 | #collapsedString = ' '.join(connect_return.split()) 38 | #PID, VID = collapsedString.split(",") 39 | #print PID 40 | #print VID 41 | print(connect_return) 42 | badlist = ['V01', 'V02', 'V03'] 43 | if "ASA" in connect_return: 44 | if any(word in connect_return for word in badlist): 45 | print("\nThis device is VULNERABLE!") 46 | else: 47 | print("\nThis device is SAFE!") 48 | else: 49 | print("\nThis isn't an ASA 5506!") 50 | print("\n>>>>>>>>> End <<<<<<<<<") 51 | # Disconnect from this session 52 | net_connect.disconnect() 53 | 54 | # Grab the Customer name to search 55 | customer = input('Customer name: ') + ".csv" 56 | # Flesh out these variables using the credentials.cred_csv module 57 | username, password, secret = credentials.cred_csv() 58 | # Give it a command: 59 | # command_string = "write mem" # can be passed to nc... 60 | # Run the primary function in this program 61 | nc(username, password, secret, customer) 62 | 63 | 64 | end_time = datetime.now() 65 | # How long did it run? 66 | total_time = end_time - start_time 67 | print("\nTotal time for script: \n" + str(total_time)) 68 | -------------------------------------------------------------------------------- /Example_Scripts/Cisco/shCDPneigh.py: -------------------------------------------------------------------------------- 1 | # Global imports 2 | from netmiko import ConnectHandler 3 | from datetime import datetime 4 | import csv, os.path 5 | 6 | # Local imports 7 | import credentials 8 | 9 | # Begin timing the script 10 | start_time = datetime.now() 11 | 12 | # Define the primary function (to be moved to a separate module some day...) 13 | def nc(username, password, secret, customer): 14 | with open(customer, mode='r') as csvfile: 15 | reader = csv.DictReader(csvfile) 16 | 17 | # Now iterate through every row in the CSVfile and make dictionaries 18 | for row in reader: 19 | hostname = row['SysName'] 20 | device_type = row['device_type'] 21 | ip = row['IP_Address'] 22 | switch = { 23 | 'device_type': device_type, 24 | 'ip': ip, 25 | 'username': username, 26 | 'password': password, 27 | 'secret': secret, 28 | 'verbose': False, 29 | } 30 | 31 | # This is your connection handler for commands from here on out 32 | net_connect = ConnectHandler(**switch) 33 | 34 | # Insert your commands here 35 | # net_connect.enable() 36 | # or maybe send configuration stuff with 37 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 38 | command_string = 'show cdp neigh' 39 | connect_return = net_connect.send_command(command_string) 40 | 41 | # Now make it pretty 42 | print("\n\n>>>>>>>>> Device {0} <<<<<<<<<".format(row['SysName'])) 43 | print(connect_return) 44 | print("\n>>>>>>>>> End <<<<<<<<<") 45 | 46 | # Disconnect from this session 47 | net_connect.disconnect() 48 | 49 | # Grab the Customer name to search 50 | customer = input('Customer name: ') + ".csv" 51 | 52 | # Flesh out these variables using the credentials.cred_csv module 53 | username, password, secret = credentials.cred_csv() 54 | 55 | # Run the primary function in this program 56 | nc(username, password, secret, customer) 57 | 58 | 59 | end_time = datetime.now() 60 | 61 | # How long did it run? 62 | total_time = end_time - start_time 63 | print("\nTotal time for script: \n" + str(total_time)) 64 | -------------------------------------------------------------------------------- /Example_Scripts/Fortigate/Bypass_Report.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This script will produce a report of the current whitelist objects of the input 3 | address-group on the fortiOS appliance. 4 | 5 | Usage: 6 | Bypass_Report.py -h | --help 7 | Bypass_Report.py [-o FILE] [--debug] 8 | 9 | Options: 10 | -h, --help Shows this menu. 11 | -d, --debug Print debug information. This is the most verbose 12 | option. 13 | -o FILE Output xlsx file [default: FW_Report.xlsx] 14 | ''' 15 | 16 | import logging 17 | import configparser 18 | import xlsxwriter 19 | from docopt import docopt 20 | from netmiko import ConnectHandler 21 | 22 | # Parse the .ini config file, this will let us set more permanent values 23 | config = configparser.ConfigParser() 24 | config.read("fortios.ini") 25 | whitelist_name = config.get("fortios", "whitelist") 26 | 27 | # Initialize docopt for arg parsing on the CLI 28 | arguments = docopt(__doc__) 29 | 30 | # Set logging level https://www.digitalocean.com/community/tutorials/how-to-use-logging-in-python-3 31 | # This is for debugging. 32 | if arguments['--debug'] == True: 33 | logging.basicConfig(level=logging.DEBUG) 34 | print("Arguments: \n" + str(arguments)) 35 | else: 36 | logging.basicConfig(level=logging.WARNING) 37 | 38 | # Initialize a Workbook object and add a new worksheet to it (for output) 39 | workbook = xlsxwriter.Workbook(arguments['-o']) 40 | worksheet = workbook.add_worksheet() 41 | logging.info("Workbook " + str(arguments['-o']) + " loaded, and worksheet set...") 42 | 43 | # Lists, declared globally is bad but it gets the job done 44 | devices = [] 45 | ips = (config.get("fortios", "firewall_ip")).split(',') 46 | rulename = [] 47 | comment = [] 48 | subset = [] 49 | 50 | # A hacky workaround for FortiOS not having a 'tree' view of firewall rules 51 | def groupparse(addr): 52 | '''Use to parse down until you hit addresses, not addrgrps''' 53 | output = net_connect.send_command('show firewall addrgrp ' + str(addr) + ' | grep member') 54 | # Tidy data up 55 | output = output.split(' ') 56 | output = list(filter(None, output)) 57 | output[-1] = output[-1].strip() 58 | output.remove('set') 59 | output.remove('member') 60 | for grp in output: 61 | newout = net_connect.send_command('show firewall address ' + str(grp) + ' | grep comment') 62 | if "Return code -163" in newout: 63 | # Recursive lookups 64 | rulename.append(grp) 65 | grpcom = net_connect.send_command('show firewall addrgrp ' + str(grp) + ' | grep comment') 66 | grpcom = grpcom[grpcom.find('"'):] 67 | comment.append(grpcom) 68 | subset.append("This is a GROUP") 69 | groupparse(newout) 70 | else: 71 | newout = newout[newout.find('"'):] 72 | # This only shows subset for the direct group, if we had 73 | # nested groups it would not show the tree 74 | # print(grp, newout, "subset: " + str(addr)) 75 | rulename.append(grp) 76 | comment.append(newout) 77 | subset.append(str(addr)) 78 | 79 | # Build connection dictionaries for each firewall you need to connect to 80 | for ip in ips: 81 | logging.debug("Creating device dict for " + ip) 82 | fortinet = { 83 | 'device_type': 'fortinet', 84 | 'ip': ip, 85 | 'username': str(config.get("fortios", "username")), 86 | 'password': str(config.get("fortios", "password")) 87 | } 88 | devices.append(fortinet) 89 | logging.debug("Finished device dict:\n" + str(devices)) 90 | 91 | # Initial loop. This is a hack due to the FortiOS device not having a 'tree' 92 | # view of the firewall objects 93 | for device in devices: 94 | logging.debug("Attempting connection to " + str(device['ip'])) 95 | net_connect = ConnectHandler(**device) 96 | logging.debug("Sending command to " + str(device['ip'])) 97 | output = net_connect.send_command('show firewall addrgrp ' + str(whitelist_name) + ' | grep member') 98 | # Tidy data up 99 | output = output.split(' ') 100 | output = list(filter(None, output)) 101 | output[-1] = output[-1].strip() 102 | output.remove('set') 103 | output.remove('member') 104 | #print(output) 105 | for addr in output: 106 | newout = net_connect.send_command('show firewall address ' + str(addr) + ' | grep comment') 107 | if "Return code -163" in newout: 108 | rulename.append(addr) 109 | grpcom = net_connect.send_command('show firewall addrgrp ' + str(addr) + ' | grep comment') 110 | grpcom = grpcom[grpcom.find('"'):] 111 | comment.append(grpcom) 112 | subset.append("This is a GROUP") 113 | groupparse(addr) 114 | else: 115 | newout = newout[newout.find('"'):] 116 | #print(addr, newout) 117 | rulename.append(addr) 118 | comment.append(newout) 119 | subset.append(" ") 120 | 121 | listoflists = { 122 | 'Rule Names': rulename, 123 | 'Comment': comment, 124 | 'Group Membership': subset 125 | } 126 | 127 | # Change column width to make it readable. Not needed for import 128 | # but it looks nicer this way for verification 129 | worksheet.set_column(0, 0, width=50) 130 | worksheet.set_column(1, 1, width=80) 131 | worksheet.set_column(2, 2, width=50) 132 | 133 | # This iterates over each key, writes the key out to the first row, and the 134 | # corresponding list in that column, per-key and per-column 135 | colnum = 0 136 | for key in listoflists.keys(): 137 | worksheet.write(0, colnum, key) 138 | worksheet.write_column(1, colnum, listoflists[key]) 139 | colnum += 1 140 | logging.debug("Added " + str(listoflists[key])) 141 | 142 | # Close the open workbook i/o object 143 | workbook.close() 144 | logging.info("Closed Workbook " + str(arguments['-o'])) -------------------------------------------------------------------------------- /Example_Scripts/Fortigate/blacklist_fortinet.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This script is dead simple--it formats the commands to add a single 3 | IP to the blacklist 4 | ''' 5 | 6 | IPADDR = input("What is the IP you wish to block? ") 7 | IPBL = "Ext.Blacklist." + IPADDR 8 | print("\n------------------------------------------------------------\n") 9 | print("show firewall address " + IPBL) 10 | print("\n------------------------------------------------------------") 11 | print("------------------------------------------------------------\n") 12 | print("show firewall addrgrp Ext.Blacklist") 13 | print("\n------------------------------------------------------------") 14 | print("------------------------------------------------------------\n") 15 | print("config firewall address") 16 | print(" edit \"" + IPBL + "\"") 17 | print(" set comment \"Blocking due to ongoing malicious behavior\"") 18 | print(" set subnet " + IPADDR + " 255.255.255.255") 19 | print("end") 20 | print("\n------------------------------------------------------------") 21 | print("------------------------------------------------------------\n") 22 | print("config firewall addrgrp") 23 | print(" edit \"Ext.Blacklist\"") 24 | print(" append member " + IPBL) 25 | print("end") 26 | print("\n------------------------------------------------------------") 27 | -------------------------------------------------------------------------------- /Example_Scripts/Fortigate/fortiport.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This script will parse a daily report, called Threats.csv, and spit out relevant information 3 | so that we can save time on risk mitigation in the morning. 4 | ''' 5 | 6 | import csv 7 | import socket 8 | import configparser 9 | 10 | config = configparser.ConfigParser() 11 | config.read("netsparkconfig.ini") 12 | vulnerabilities = (config.get("fortiport", "vulnerabilities")).split(',') 13 | domaincheck = (config.get("fortiport", "domain_names")).split(',') 14 | REPORTNAME = "Threats.csv" 15 | 16 | def getListItemIndex(itemname, listname): 17 | 'This queries listname for itemname, and returns the index of that list containing itemname' 18 | for list1 in listname: 19 | for item in list1: 20 | if item == itemname: 21 | n1 = listname.index(list1) 22 | n2 = list1.index(item) 23 | return n1, n2 24 | 25 | def getMatchesIP(index1, index2): 26 | 'This provides relevant information from the report' 27 | for i in range(index1, index2): 28 | if '10.0' in str(fortilist[i]): 29 | try: 30 | print(fortilist[i][1] + " --> " + socket.gethostbyaddr(fortilist[i][1])) 31 | except: 32 | print(fortilist[i][1]) 33 | if '172.16' in str(fortilist[i]): 34 | try: 35 | print(fortilist[i][1] + " --> " + socket.gethostbyaddr(fortilist[i][1])) 36 | except: 37 | print(fortilist[i][1]) 38 | for k in domaincheck: 39 | if k in str(fortilist[i]): 40 | try: 41 | print(fortilist[i][1] + " --> " + socket.gethostbyname(fortilist[i][1])) 42 | except: 43 | print(fortilist[i][1]) 44 | 45 | def getMatchesInfect(ind1, ind2): 46 | 'This provides matches to stuff we care about' 47 | for i in range(ind1, ind2): 48 | for j in vulnerabilities: 49 | if j in str(fortilist[i]).lower(): 50 | print(fortilist[i][1] + " " + fortilist[i][2]) 51 | 52 | 53 | 54 | with open (REPORTNAME, 'r') as f: 55 | reader = csv.reader(f) 56 | fortilist = list(reader) 57 | 58 | intvic = getListItemIndex('###Intrusion Victims###', fortilist) 59 | intsrc = getListItemIndex('###Intrusion Sources###', fortilist) 60 | intblk = getListItemIndex('###Intrusions Blocked###', fortilist) 61 | inttml = getListItemIndex('###Intrusion Timeline###', fortilist) 62 | 63 | #VICTIMS 64 | print('\n--------Intrusion Victims--------\n') 65 | getMatchesIP(intvic[0], intsrc[0]) 66 | print('\n---------------------------------\n') 67 | 68 | #SOURCES 69 | print('\n--------Intrusion Sources--------\n') 70 | getMatchesIP(intsrc[0], intblk[0]) 71 | print('\n---------------------------------\n') 72 | 73 | #BLOCKEDLIST 74 | print('\n--------Intrusions Blocked-------\n') 75 | getMatchesInfect(intblk[0], inttml[0]) 76 | print('\n---------------------------------\n') 77 | -------------------------------------------------------------------------------- /Example_Scripts/TinyDB/dbInputData.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Usage: 3 | dbInputData.py 4 | dbInputData.py -h | --help 5 | dbInputData.py [--debug] [-i INPUT] [-o FILE] 6 | 7 | Options: 8 | -h, --help Shows this menu. 9 | -d, --debug Print debug information. This is the most verbose 10 | option. 11 | -i INPUT Input file [default: test.csv] 12 | -o FILE TinyDB database to output to. [default: netspark.json] 13 | ''' 14 | 15 | import logging 16 | import csv 17 | from tinydb import TinyDB, Query 18 | from docopt import docopt 19 | 20 | 21 | arguments = docopt(__doc__) 22 | 23 | # Set logging level https://www.digitalocean.com/community/tutorials/how-to-use-logging-in-python-3 24 | if arguments['--debug'] == True: 25 | logging.basicConfig(level=logging.DEBUG) 26 | print("Arguments: \n" + str(arguments)) 27 | else: 28 | logging.basicConfig(level=logging.INFO) 29 | 30 | # Define the Database 31 | DB = TinyDB(arguments['-o']) 32 | logging.info("Set TinyDB database to: " + str(arguments['-o'])) 33 | logging.debug("Loaded database: " + str(DB)) 34 | 35 | # The test file 36 | CSVFILE = arguments['-i'] 37 | logging.info("Set CSV input file to: " + str(CSVFILE)) 38 | 39 | # The Magic (read CSV as dict, form dict with data we care about, dump it into db) 40 | with open(CSVFILE, mode='r') as csvfile: 41 | logging.debug("Attempting load of CSVFILE into dictionary...") 42 | READER = csv.DictReader(csvfile) 43 | logging.debug("csv.DictReader load success") 44 | # Now iterate through every row in the CSVfile and make dictionaries 45 | for row in READER: 46 | logging.debug("Iterating through csv dictionary rows...") 47 | dbdict = { 48 | 'hostname': row['SysName'], 49 | 'device_type': row['device_type'], 50 | 'ipaddr': row['IP_Address'], 51 | 'department': row['Department'] 52 | } 53 | logging.debug("Made the following dbdict: " + str(dbdict)) 54 | 55 | Find = Query() 56 | logging.debug("Begin searching for IP Address using dbdict['ipaddr']") 57 | ifexists = DB.contains(Find.ipaddr == dbdict['ipaddr']) 58 | if ifexists is True: 59 | logging.debug("Found match for IP. Updating values...") 60 | DB.update({'hostname': dbdict['hostname']}, Find.ipaddr == dbdict['ipaddr']) 61 | DB.update({'device_type': dbdict['device_type']}, Find.ipaddr == dbdict['ipaddr']) 62 | DB.update({'department': dbdict['department']}, Find.ipaddr == dbdict['ipaddr']) 63 | logging.debug("Updated DB with values: " + str(dbdict)) 64 | else: 65 | logging.debug("No match found for IP. Adding new DB entry...") 66 | DB.insert(dbdict) 67 | logging.debug("Added new values: " + str(dbdict)) 68 | -------------------------------------------------------------------------------- /Example_Scripts/TinyDB/dbquery.py: -------------------------------------------------------------------------------- 1 | """ 2 | ------------------------------------------------------------------------------- 3 | This script just queries the database as a test for me. It can be used as an 4 | example of how TinyDB queries can be done. 5 | I'm just sick of typing it in the interpreter over and over. 6 | ------------------------------------------------------------------------------- 7 | """ 8 | from tinydb import TinyDB, Query 9 | 10 | # Define the Database 11 | DB = TinyDB('netspark.json') 12 | 13 | def querydept(department): 14 | Device = Query() 15 | dblineD = DB.search(Device.department == department) 16 | return dblineD 17 | 18 | def queryip(ip): 19 | Device = Query() 20 | dblineI = DB.search(Device.ip == ip) 21 | return dblineI 22 | 23 | def queryhost(hostname): 24 | Device = Query() 25 | dblineH = DB.search(Device.hostname == hostname) 26 | return dblineH 27 | 28 | def querytype(device_type): 29 | Device = Query() 30 | dblineT = DB.search(Device.device_type == device_type) 31 | return dblineT -------------------------------------------------------------------------------- /Example_Scripts/TinyDB/populateTinyDB.py: -------------------------------------------------------------------------------- 1 | """ 2 | ------------------------------------------------------------------------------- 3 | This script takesinput from a CSV file, specifically Solarwinds, and stores 4 | the information in a TinyDB database. This will be the first step in converting 5 | to using TinyDB: getting the data IN the database. 6 | ------------------------------------------------------------------------------- 7 | 8 | """ 9 | # External 10 | from tinydb import TinyDB, Query 11 | from datetime import datetime 12 | import csv, os.path 13 | import codecs 14 | # Local 15 | import convencoding 16 | 17 | # Begin timing the script 18 | start_time = datetime.now() 19 | 20 | # Define the Database 21 | db = TinyDB('netspark.json') 22 | 23 | # Point it at the CSV file 24 | filename = input("Name of the CSV file to import: ") 25 | # filename = "ASA.csv" 26 | # Function populate() will parse the SW config file and add it to our TinyDB 27 | def populate(): 28 | ''' Populates the DB with data. This is old code, needs cleanup ''' 29 | with open(filename, mode='r') as f: 30 | reader = csv.DictReader(f) 31 | # Now iterate through every row in the CSVfile and set variables 32 | for row in reader: 33 | ip = row['IP_Address'] 34 | hostname = row['SysName'] 35 | device_type = row['device_type'] 36 | department = row['Department'] 37 | switch = { 38 | 'ip': row['IP_Address'], 39 | 'hostname': row['SysName'], 40 | 'device_type': row['device_type'], 41 | 'department': row['Department'] 42 | } 43 | 44 | dbf = Query() 45 | resultf = db.search(dbf.ip == row['IP_Address']) 46 | if str(resultf) != "[]": 47 | print("Skipping " + row['IP_Address'] + " as it already exists.") 48 | else: 49 | db.insert(switch) 50 | print ("Added " + row['IP_Address']) 51 | 52 | populate() 53 | 54 | # Kill the clock! 55 | end_time = datetime.now() 56 | # How long did it run? 57 | total_time = end_time - start_time 58 | print ("\nTotal time for script: \n" + str(total_time)) -------------------------------------------------------------------------------- /Example_Scripts/TinyDB/qdb.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script is for testing EasyGUI 4 | ------------------------------------------------------------------------------- 5 | ''' 6 | # Separated namespace 7 | import easygui as g 8 | # Local functions 9 | import dbquery 10 | 11 | OPENINGMSG = "What would you like to look up?" 12 | TITLE = "DB Query Application" 13 | CHOICES = ["Department", "IP", "Hostname", "Device Type"] 14 | CHOICE = g.choicebox(OPENINGMSG, TITLE, CHOICES) 15 | 16 | if CHOICE == "Department": 17 | department = g.enterbox("What is the dept you want to search for?", TITLE) 18 | RDept = dbquery.querydept(department) 19 | g.msgbox(RDept, TITLE) 20 | 21 | elif CHOICE == "IP": 22 | ip = g.enterbox("What is the ip you want to search for?", TITLE) 23 | RIP = dbquery.queryip(ip) 24 | g.msgbox(RIP, TITLE) 25 | 26 | elif CHOICE == "Hostname": 27 | hostname = g.enterbox("What is the hostname you want to search for?", TITLE) 28 | RHost = dbquery.queryip(hostname) 29 | g.msgbox(RHost, TITLE) 30 | 31 | elif CHOICE == "Device Type": 32 | device_type = g.enterbox("What is the device type you want to search for?", TITLE) 33 | RdType = dbquery.queryip(device_type) 34 | g.msgbox(RdType, TITLE) 35 | -------------------------------------------------------------------------------- /Example_Scripts/Utilities/convencoding.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This function simply converts a file to UTF-8 from UTF-16. It's needed for 4 | Solarwinds integration 5 | ------------------------------------------------------------------------------- 6 | ''' 7 | 8 | def conv(filename): 9 | """Takes a file name string as input, converts to UTF-8""" 10 | target_file = input('What is the name of the customer? \n') + ".csv" 11 | with open(filename, 'rb') as source_file: 12 | with open(target_file, 'w+b') as dest_file: 13 | contents = source_file.read() 14 | dest_file.write(contents.decode('utf-16').encode('utf-8')) 15 | return target_file 16 | -------------------------------------------------------------------------------- /Example_Scripts/Utilities/fixCSV.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script is the basis for converting Solarwinds exportCP.csv files to 4 | a useable format! In the future, this will be step one of two for importing 5 | customer data into a local TinyDB 6 | ------------------------------------------------------------------------------- 7 | ''' 8 | from datetime import datetime 9 | import csv 10 | # Local 11 | import convencoding 12 | 13 | # Begin timing the script 14 | start_time = datetime.now() 15 | 16 | #The Solarwinds file 17 | filename = "exportCP.csv" 18 | #Use convencoding to convert the encoding 19 | fixfile = convencoding.conv(filename) 20 | print(str(fixfile) + " file has been created.") 21 | 22 | # Point it at the CSV file 23 | with open(fixfile, mode='r') as f: 24 | reader = csv.DictReader(f) 25 | # Headers 26 | fieldnames = reader.fieldnames 27 | with open(fixfile, mode='wb') as outfile: 28 | writer = csv.DictWriter(outfile, fieldnames=fieldnames) 29 | # Write Headers 30 | writer.writeheader() 31 | #Do some magic--change values to Netmiko compliance 32 | for row in reader: 33 | if row['Vendor'] == "Cisco": 34 | row['Vendor'] = "cisco_ios" 35 | # Don't need this row, I know it's dirty, this is not the end 36 | del row['sha1(Department)'] 37 | writer.writerow(row) 38 | 39 | # Stolen off the interwebz, to fix the improper dict tag (py2 has no replace 40 | # for Dicts) 41 | with open(fixfile) as f: 42 | vendfix = f.read().replace('Vendor', 'device_type') 43 | with open(fixfile, "w") as f: 44 | f.write(vendfix) 45 | 46 | 47 | # Kill the clock! 48 | end_time = datetime.now() 49 | # How long did it run? 50 | total_time = end_time - start_time 51 | print("\nTotal time for script: \n" + str(total_time)) 52 | -------------------------------------------------------------------------------- /Example_Scripts/Utilities/formatCW.py: -------------------------------------------------------------------------------- 1 | ''' This formats an email and updates a ticket in ConnectWise''' 2 | import smtplib 3 | import pyperclip 4 | 5 | upd8 = pyperclip.paste() 6 | 7 | # Optional, or just set the variable here 8 | servername = "emailserver.contoso.com" 9 | serverport = 25 10 | 11 | ticketnum = input("Enter the ticket number: ") 12 | body = "!!AddInternal:" + upd8 + "!!" 13 | fromadd = "JohnUser@contoso.com" 14 | toadd = "CWpilot@contoso.com" 15 | 16 | 17 | server = smtplib.SMTP(servername, serverport) 18 | msg = """From: JohnUser@contoso.com 19 | To: CWpilot@contoso.com 20 | Subject: Ticket#{0} 21 | 22 | """.format(ticketnum) + body 23 | 24 | #print msg 25 | # Send it 26 | 27 | server = smtplib.SMTP(servername) 28 | server.sendmail(fromadd, toadd, msg) 29 | server.quit() 30 | 31 | print(("\nSent the following to Ticket#{0}: \n").format(ticketnum) + msg) 32 | -------------------------------------------------------------------------------- /Example_Scripts/Utilities/get_dns_records.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding utf-8 -*- 3 | # 4 | # Copyright 2016 Akshay Raj Gollahalli 5 | # STILL BROKEN 6 | 7 | import dns.resolver 8 | 9 | 10 | def get_records(domain): 11 | """ 12 | Get all the records associated to domain parameter. 13 | :param domain: 14 | :return: 15 | """ 16 | ids = [ 17 | 'NONE', 18 | 'A', 19 | 'NS', 20 | 'MD', 21 | 'MF', 22 | 'CNAME', 23 | 'SOA', 24 | 'MB', 25 | 'MG', 26 | 'MR', 27 | 'NULL', 28 | 'WKS', 29 | 'PTR', 30 | 'HINFO', 31 | 'MINFO', 32 | 'MX', 33 | 'TXT', 34 | 'RP', 35 | 'AFSDB', 36 | 'X25', 37 | 'ISDN', 38 | 'RT', 39 | 'NSAP', 40 | 'NSAP-PTR', 41 | 'SIG', 42 | 'KEY', 43 | 'PX', 44 | 'GPOS', 45 | 'AAAA', 46 | 'LOC', 47 | 'NXT', 48 | 'SRV', 49 | 'NAPTR', 50 | 'KX', 51 | 'CERT', 52 | 'A6', 53 | 'DNAME', 54 | 'OPT', 55 | 'APL', 56 | 'DS', 57 | 'SSHFP', 58 | 'IPSECKEY', 59 | 'RRSIG', 60 | 'NSEC', 61 | 'DNSKEY', 62 | 'DHCID', 63 | 'NSEC3', 64 | 'NSEC3PARAM', 65 | 'TLSA', 66 | 'HIP', 67 | 'CDS', 68 | 'CDNSKEY', 69 | 'CSYNC', 70 | 'SPF', 71 | 'UNSPEC', 72 | 'EUI48', 73 | 'EUI64', 74 | 'TKEY', 75 | 'TSIG', 76 | 'IXFR', 77 | 'AXFR', 78 | 'MAILB', 79 | 'MAILA', 80 | 'ANY', 81 | 'URI', 82 | 'CAA', 83 | 'TA', 84 | 'DLV', 85 | ] 86 | 87 | google_resolver = dns.resolver.Resolver() 88 | google_resolver.nameservers = ['8.8.8.8'] 89 | 90 | for a in ids: 91 | try: 92 | answers = google_resolver.query(domain, a) 93 | for rdata in answers: 94 | print(a, ':', rdata.to_text()) 95 | 96 | except Exception as e: 97 | print(e) # or pass 98 | 99 | if __name__ == '__main__': 100 | DOMAIN = input("Url: ") 101 | get_records(DOMAIN) 102 | -------------------------------------------------------------------------------- /Example_Scripts/Utilities/multitest.py: -------------------------------------------------------------------------------- 1 | from multiprocessing import pool 2 | from multiprocessing.dummy import Pool as Threadpool 3 | 4 | 5 | 6 | def worker(listnum): 7 | """thread worker function""" 8 | squared = (listnum**2) 9 | print(str(listnum) + ' squared is ' + str(squared)) 10 | 11 | 12 | pool = Threadpool() 13 | 14 | ilist = list(range(1,200000)) 15 | results = pool.map(worker, ilist) 16 | 17 | pool.close() 18 | pool.join() 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /PythonLinks.md: -------------------------------------------------------------------------------- 1 | # Python links 2 | 3 | ### Included in NetSpark repo 4 | [Netmiko](https://pynet.twb-tech.com/blog/automation/netmiko.html) 5 | 6 | [Netmiko Github](https://github.com/ktbyers/netmiko) 7 | 8 | 9 | ### Interesting Links 10 | [Pyperclip](http://pyperclip.readthedocs.io/en/latest/introduction.html) 11 | 12 | [OrionSDK](https://github.com/solarwinds/OrionSDK/wiki) 13 | 14 | [OrionSDK Links](https://thwack.solarwinds.com/thread/102784) 15 | 16 | [Thycotic Secret Safe API](https://thycotic.force.com/support/s/article/Accessing-Secret-Server-Programmatically-Python-Sample-Script) 17 | 18 | [Ops School](http://www.opsschool.org/en/latest/introduction.html) 19 | 20 | [Jinja2](http://jinja.pocoo.org/docs/dev/) 21 | 22 | [Flowgraph](https://github.com/pierky/flowgraph) 23 | 24 | [Level Up](https://www.reddit.com/r/learnpython/comments/5pqd31/how_to_level_up_from_scriptsprojects_to_software/) 25 | 26 | [DocOpt](https://github.com/docopt/docopt) 27 | 28 | [Numpy Cheatsheet](https://www.datacamp.com/community/blog/python-numpy-cheat-sheet#gs.SABlgNU) 29 | 30 | [Pandas Cheatsheet](https://github.com/pandas-dev/pandas/blob/master/doc/cheatsheet/Pandas_Cheat_Sheet.pdf) 31 | 32 | [Scikit-Learn Cheatsheet](https://s3.amazonaws.com/assets.datacamp.com/blog_assets/Scikit_Learn_Cheat_Sheet_Python.pdf) 33 | 34 | ### Links for Future Features 35 | [Cisco ASA Site-to-Site VPN Debugs](http://www.cisco.com/c/en/us/support/docs/security/asa-5500-x-series-next-generation-firewalls/115935-asa-ikev2-debugs.html) 36 | 37 | [Cisco Debug ASA Session](https://supportforums.cisco.com/discussion/11794906/how-debug-ssh-session-asa) 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

Netspark-Scripts

2 | 3 |

Multithreaded parallel network command execution, simplified, for network engineers of the world!

4 | 5 | ![Python](https://img.shields.io/badge/Python-3.4%2C%203.5%2C%203.6-green.svg) 6 | 7 | ## Table of Contents 8 | 9 | - [Prerequisites](#prerequisites) 10 | - [Installation](#installation) 11 | - [Usage](#usage) 12 | - [Contributing](#contributing) 13 | 14 | ## Prerequisites 15 | 16 | For everything: 17 | 18 | ```pip install netmiko docopt getpass``` 19 | 20 | ## Installation 21 | 22 | Clone the repo, and run the scripts using Python 3. This is NOT a library or module, it is meant to be templates and examples that you can use, copy, and make better. 23 | 24 | ## Usage 25 | 26 | Create your 'customer' file and 'credentials' file based on exampleCSV.md. 27 | 28 | #### python netspark.py -h 29 | This script is the master controller script. It will make the necessary 30 | commands to run whatever is needed against whatever is needed. 31 | 32 | Usage: 33 | netspark.py -h | --help 34 | netspark.py (--info COMMAND | --config CONFIGFILE) (--csv FILENAME | --db QUERYNAME | --ip IPADDR) [-c CREDFILE] [--debug] 35 | 36 | Options: 37 | -h, --help Shows this menu. 38 | -d, --debug Print debug information. This is the most verbose 39 | option. 40 | --info COMMAND This will run regular show commands 41 | --config CONFIGFILE This will run configuration commands 42 | --csv FILENAME Input file if using CSV [default: test.csv] 43 | --db QUERYNAME SQL field: 'groupname' [default: test] 44 | --ip IPADDR Single IP address of test switch 45 | -c CREDFILE Crednetials file [default: credentials.csv] 46 | 47 | ### Examples: 48 | To run write mem on every host in your csv file switches.csv (assuming you only have one credentials.csv): 49 | 50 | `python netspark.py --info "wr mem" --csv switches.csv` 51 | 52 | To make a config change with many lines, such as changing a local account, you'd make a text file with the lines to change it which will then be run against the hosts. For example, lets make a changeuser.txt: 53 | 54 | ``` 55 | exit 56 | conf t revert time 5 57 | username secretbackdoor privilege 15 password Thiscantbereal! 58 | ``` 59 | 60 | --config runs in the context of config mode, which is why I use an exit above. 61 | 62 | Then you'd run it like so: `python netspark.py --config changeuser.txt --csv switches.csv` 63 | 64 | This command supports all of the netmiko classes of devices, but I designed it to be used with Cisco gear since that's what most of us run. You just need to specify a different device object in your switches.csv file to work with new stuff. 65 | 66 | Final example, lets say you have a rogue sysadmin at one branch who refuses to use newer credentials/radius/whatever. So you have a different nonstandard set of creds and routers. 67 | 68 | `python netspark.py --info "configure confirm" --csv crappyrouters.csv -c crappycreds.csv` 69 | 70 | ### Caveats 71 | 72 | This is multithreaded and I haven't added error handling. I force all of my changes to use config revision (the 'conf t revert time 5' above) as a workaround until I have good error handling in place. It's laziness and a lack of time, it would be decently easy to implement. 73 | 74 | The multiprocess code I wrote is messy because of context issues. I plan on making that part into a library later on, but something something time and laziness. 75 | 76 | The default number of simultaneous executions is 8, I have run this successfully at 50x simultaneous on a network of 400+ devices but keep in mind that they will return output at a rate of 50x, and it spits it out to STDOUT, so you might want to just leave it. 77 | 78 | I will add support for --db and --ip later on, probably --db first because I want this to dive into the rest of my open-source stack I'm slowly writing about on https://teamignition.us so that this all ties in beautifully. 79 | 80 | ## The Example_Scripts folder 81 | This is old code and alternative projects. It is useful reference material so I'm leaving it up, but it will not be updated. 82 | 83 | ## Contributing 84 | 85 | All patches welcome! Please read [CONTRIBUTING.md](https://github.com/admiralspark/netspark-scripts/CONTRIBUTING.md) for furthers details...whenever I make it. For now, submit PR's and we'll chat about them. 86 | 87 | ## License 88 | 89 | GNU GPL Version 3 - see the [LICENSE](https://github.com/admiralspark/NetSpark-Scripts/blob/master/LICENSE) file for details 90 | -------------------------------------------------------------------------------- /credentials.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This function loads the credentials from a CSV file for connecting to your 4 | devices. Will hopefully become an *option* in the future instead of the only 5 | one supported. 6 | ------------------------------------------------------------------------------- 7 | ''' 8 | 9 | import csv 10 | import os.path 11 | import getpass 12 | 13 | #Read in the credentials from file 14 | def cred_csv(filename="credentials.csv"): 15 | """Check for existence of credentials file, read data if True, else ask for it manually""" 16 | if os.path.isfile(filename) is True: 17 | with open(filename, mode='r') as credfile: 18 | reader = csv.DictReader(credfile) 19 | for row in reader: 20 | username = row['username'] 21 | password = row['password'] 22 | secret = row['secret'] 23 | return (username, password, secret) 24 | else: 25 | username = input("Username? ") 26 | password = getpass.getpass("Password? ") 27 | secret = getpass.getpass("Enable Password? ") 28 | return (username, password, secret) 29 | -------------------------------------------------------------------------------- /exampleCSV.md: -------------------------------------------------------------------------------- 1 | #How to make a 'company.csv' file 2 | For your **'company.csv'** you'll want something with this format: 3 | 4 | IP_Address,SysName,device_type,authentication 5 | 10.0.0.1,HOST-SW-1,cisco_ios,LOCAL 6 | 7 | For your **'credentials.csv'** you'll want something like this: 8 | 9 | username,password,secret 10 | cisco,cisco123,enable123 11 | -------------------------------------------------------------------------------- /netspark.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This script is the master controller script. It will make the necessary 3 | commands to run whatever is needed against whatever is needed. 4 | 5 | Usage: 6 | netspark.py -h | --help 7 | netspark.py (--info COMMAND | --config CONFIGFILE) (--csv FILENAME | --db QUERYNAME | --ip IPADDR) [-c CREDFILE] [--debug] 8 | 9 | Options: 10 | -h, --help Shows this menu. 11 | -d, --debug Print debug information. This is the most verbose 12 | option. 13 | --info COMMAND This will run regular show commands 14 | --config CONFIGFILE This will run configuration commands 15 | --csv FILENAME Input file if using CSV [default: test.csv] 16 | --db QUERYNAME SQL field: 'groupname' [default: test] 17 | --ip IPADDR Single IP address of test switch 18 | -c CREDFILE Crednetials file [default: credentials.csv] 19 | ''' 20 | 21 | import os.path 22 | import logging 23 | from docopt import docopt 24 | import spark_threaded as st 25 | 26 | 27 | arguments = docopt(__doc__) 28 | 29 | # Set logging level https://www.digitalocean.com/community/tutorials/how-to-use-logging-in-python-3 30 | # This is for debugging. 31 | if arguments['--debug'] == True: 32 | logging.basicConfig(level=logging.DEBUG) 33 | print("Arguments: \n" + str(arguments)) 34 | else: 35 | logging.basicConfig(level=logging.WARNING) 36 | 37 | # Global variable MODE stores whether we're running config or not. This is here instead of defined 38 | # in the functions below because I'm going to use it for testing. 39 | MODE = st.check_config_mode(arguments['--config']) 40 | logging.debug("Value for MODE evaluated to: " + str(MODE)) 41 | 42 | if MODE is False: 43 | st.info_command(arguments['--info'], arguments['--csv'], arguments['--db'], arguments['--ip'], arguments['-c']) 44 | 45 | elif MODE is True: 46 | COMMANDLIST = [] 47 | if os.path.exists(arguments['--config']): 48 | with open(arguments['--config']) as conffile: 49 | for row in conffile: 50 | COMMANDLIST.append(row) 51 | st.COMMANDLIST = COMMANDLIST 52 | st.config_command(arguments['--config'], arguments['--csv'], arguments['--db'], arguments['--ip'], arguments['-c']) 53 | 54 | else: 55 | logging.info("You somehow broke the required info/config arguments!") -------------------------------------------------------------------------------- /spark_single.py: -------------------------------------------------------------------------------- 1 | ''' 2 | This module is a base for single-thread scripts. 3 | ''' 4 | 5 | #Global imports 6 | from datetime import datetime 7 | import csv 8 | from netmiko import ConnectHandler 9 | #Local imports 10 | import credentials 11 | 12 | # Begin timing the script 13 | STARTTIME = datetime.now() 14 | 15 | # Define the primary function (to be moved to a separate module some day...) 16 | def netcon(username, password, secret, CUSTOMER, COMMANDLIST): 17 | ''' 18 | This is the core function. Iterates through a CSV, forms a dict, runs the command 19 | and logics it. 20 | ''' 21 | with open(CUSTOMER, mode='r') as csvfile: 22 | reader = csv.DictReader(csvfile) 23 | # Now iterate through every row in the CSVfile and make dictionaries 24 | for row in reader: 25 | hostname = row['SysName'] 26 | device_type = row['device_type'] 27 | ipaddr = row['IP_Address'] 28 | switch = { 29 | 'device_type': device_type, 30 | 'ip': ipaddr, 31 | 'username': username, 32 | 'password': password, 33 | 'secret': secret, 34 | 'verbose': False, 35 | } 36 | # This is your connection handler for commands from here on out 37 | net_connect = ConnectHandler(**switch) 38 | # Insert your commands here 39 | net_connect.enable() 40 | # or maybe send configuration stuff with 41 | # net_connect.send_config_set(username cisco priv 15 pass cisco) 42 | connect_return = net_connect.send_config_set(COMMANDLIST) 43 | # Now make it pretty 44 | print("\n\n>>>>>>>>> Device {0} {1} <<<<<<<<<".format(hostname, ipaddr)) 45 | print(connect_return) 46 | print("\n>>>>>>>>> End <<<<<<<<<") 47 | # Disconnect from this session 48 | net_connect.disconnect() 49 | 50 | # Grab the Customer name to search 51 | CUSTOMER = input('Customer name: ') + ".csv" 52 | # Flesh out these variables using the credentials.cred_csv module 53 | username, password, secret = credentials.cred_csv() 54 | # Just for testing 55 | #COMMANDSTRING = input('Command string to run: ') 56 | COMMANDLIST = [] 57 | command = input("Input one command per line, end with an extra newline: ") 58 | while command is not "": 59 | COMMANDLIST.append(command) 60 | command = input("Input one command per line, end with an extra newline: ") 61 | 62 | # Run the primary function in this program 63 | netcon(username, password, secret, CUSTOMER, COMMANDLIST) 64 | 65 | 66 | ENDTIME = datetime.now() 67 | # How long did it run? 68 | TOTALTIME = ENDTIME - STARTTIME 69 | print("\nTotal time for script: \n" + str(TOTALTIME)) 70 | -------------------------------------------------------------------------------- /spark_threaded.py: -------------------------------------------------------------------------------- 1 | ''' 2 | ------------------------------------------------------------------------------- 3 | This script is a baseline for multithreaded conversion of all of the scripts. 4 | I'll look into converting the repo to use multithread, some day. 5 | ------------------------------------------------------------------------------- 6 | ''' 7 | 8 | from datetime import datetime 9 | import csv 10 | import logging 11 | from multiprocessing.dummy import Pool as ThreadPool 12 | #from multiprocessing.dummy import cpu_count # Broken as of March 2017 in 3.x 13 | #from netmiko import ConnectHandler 14 | import netmiko 15 | import credentials # Local import of credentials.py 16 | 17 | 18 | STARTTIME = datetime.now() # Begin timing the script 19 | 20 | COMMANDLIST = [] 21 | command = "" 22 | #POOL = ThreadPool(cpu_count() - 1) # Missing from lib as of 03/2017 23 | POOL = ThreadPool() 24 | 25 | def check_config_mode(config): 26 | '''Verifies if script is running config changes or not. Redundant.''' 27 | if config is not None: 28 | logging.debug("Config Mode Enabled") 29 | return True 30 | else: 31 | logging.debug("Config Mode Disabled") 32 | return False 33 | 34 | def generate_ip_list(custdictionary): 35 | '''Return a list of IP's from the dictionary''' 36 | ip_list = [d['IP_Address'] for d in custdictionary if 'IP_Address' in d] 37 | logging.debug("IP List generated:") 38 | logging.debug(str(ip_list)) 39 | return ip_list 40 | 41 | 42 | def generate_cust_dict(customer): 43 | '''Generates a dictionary from the customer data csv file''' 44 | with open(customer, mode='r') as csvfile: 45 | reader = csv.DictReader(csvfile) 46 | data = [] 47 | for line in reader: 48 | data.append(line) 49 | logging.debug("Customer Dictionary:") 50 | logging.debug(str(data)) 51 | return data 52 | 53 | 54 | def find_by_ip(lst, value): 55 | '''Returns the row that a specific IP is in (search for row by IP)''' 56 | for row in lst: 57 | if str(row['IP_Address']) == str(value): 58 | return row 59 | 60 | 61 | def generate_switch_dict(username, password, secret, matchrow, command): 62 | '''Makes the switch dictionary for Netmiko's connection handler''' 63 | swlist = [username, password, secret, matchrow['device_type'], matchrow['IP_Address'], matchrow['SysName'], command] 64 | logging.debug("Switchlist:") 65 | logging.debug(str(swlist)) 66 | return swlist 67 | 68 | 69 | def generate_listof_lists(custdictionary, command, creds): 70 | '''Returns a list of lists from the input dictionary''' 71 | swlist = [] 72 | if creds is not None: 73 | username, password, secret = credentials.cred_csv(creds) 74 | else: 75 | username, password, secret = credentials.cred_csv() 76 | for row in custdictionary: 77 | swlist.append(generate_switch_dict(username, password, secret, row, command)) 78 | logging.debug("List of Lists:") 79 | logging.debug(str(swlist)) 80 | return swlist 81 | 82 | 83 | def switch_run_command(username, password, secret, devicetype, ipaddr, hostname, clicomm): 84 | '''All the logic happens here. Take the data, process it, print results''' 85 | sessiondict = { 86 | 'device_type': devicetype, 87 | 'ip': ipaddr, 88 | 'username': username, 89 | 'password': password, 90 | 'secret': secret, 91 | 'verbose': False 92 | } 93 | try: 94 | # Start the session, enable, send the commands, capture terminal output and remove the connections 95 | session = netmiko.ConnectHandler(**sessiondict) 96 | session.enable() 97 | session_return = session.send_command(clicomm) 98 | session.disconnect() 99 | except (netmiko.ssh_exception.NetMikoTimeoutException): 100 | session_return = "----------DEVICE CONNECTION FAILED----------" 101 | # Fancy formatting here for results 102 | print("\n\n>>>>>>>>> {0} {1} <<<<<<<<<\n".format(hostname, ipaddr) 103 | + session_return 104 | + "\n>>>>>>>>> End <<<<<<<<<\n") 105 | 106 | 107 | def switch_run_config(username, password, secret, devicetype, ipaddr, hostname, clicomm): 108 | '''All the logic happens here. Take the data, process it, print results''' 109 | sessiondict = { 110 | 'device_type': devicetype, 111 | 'ip': ipaddr, 112 | 'username': username, 113 | 'password': password, 114 | 'secret': secret, 115 | 'verbose': False 116 | } 117 | try: 118 | # Start the session, enable, send the commands, capture terminal output and remove the connections 119 | session = netmiko.ConnectHandler(**sessiondict) 120 | session.enable() 121 | session_return = session.send_config_set(COMMANDLIST) 122 | session.disconnect() 123 | except (netmiko.ssh_exception.NetMikoTimeoutException): 124 | session_return = "----------DEVICE CONNECTION FAILED----------" 125 | # Fancy formatting here for results 126 | print("\n\n>>>>>>>>> {0} {1} <<<<<<<<<\n".format(hostname, ipaddr) 127 | + session_return 128 | + "\n>>>>>>>>> End <<<<<<<<<\n") 129 | 130 | def info_command(command, csv, db, ip, creds): 131 | '''This runs a single command against all devices''' 132 | if csv is not None: 133 | switchdata = generate_cust_dict(csv) #dictionary of all switch data 134 | switchlists = generate_listof_lists(switchdata, command, creds) 135 | results = POOL.starmap(switch_run_command, switchlists) 136 | POOL.close() 137 | POOL.join() 138 | elif db is not None: 139 | # TODO 140 | print("SQL functionality is not supported at this time.") 141 | elif ip is not None: 142 | # TODO 143 | print("IP-specific functionality is not supported at this time") 144 | 145 | 146 | def config_command(config, csv, db, ip, creds): 147 | '''A variable here can be made available to a subprocess...maybe?''' 148 | if csv is not None: 149 | switchdata = generate_cust_dict(csv) #dictionary of all switch data 150 | switchlists = generate_listof_lists(switchdata, command, creds) 151 | results = POOL.starmap(switch_run_config, switchlists) 152 | POOL.close() 153 | POOL.join() 154 | elif db is not None: 155 | print("SQL functionality is not supported at this time.") 156 | elif ip is not None: 157 | print("IP-specific functionality is not supported at this time") 158 | 159 | 160 | #RESULTS = POOL.map(switch_run_command, IP_LIST) 161 | 162 | #POOL.close() 163 | #POOL.join() 164 | 165 | ENDTIME = datetime.now() 166 | TOTALTIME = ENDTIME - STARTTIME 167 | --------------------------------------------------------------------------------