-
Notifications
You must be signed in to change notification settings - Fork 0
/
Readme v2.0.4
60 lines (46 loc) · 2.76 KB
/
Readme v2.0.4
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
=========================
Installation Notes
=========================
Scripts were written and tested using python 3.6.8
No installation is required or compiling of the scripts, only requirement is python 3 with following libraries:
- pexpect
- os
- sys
- getpass
- re
In addition if telnet is the method of transport the telnet package on your system must be installed (not just the pexpect package).
=========================
Running the Scripts
=========================
To call the scripts make sure their permissions are set to executable then call them like so (telnet is default for gatherer):
python ios_xr_mw_gatherer.py --file pre_mw_file --ipv4addr 172.18.120.188 --username smilstea --ssh
python ios_xr_mw_gatherer.py --file post_mw_file --ipv4addr 172.18.120.188 --username smilstea --ssh
python ios_xr_mw_comparer.py --pre pre_mw_file --post post_mw_file --compare comparison_filename
Syntax for each file is below:
Usage: python ios_xr_mw_gatherer.py [--file <filename>][--ipv4addr <ipv4 address>][--username <username>](--ssh)(--timeout <seconds>) (--vsm)
Usage: python ios_xr_mw_comparer.py [--pre <filename>|--post <filename>][--compare <filename>](--minimal)(--vsm)
=========================
Special Keywords
=========================
--timeout
Specifies the timeout from commands, by default this is 10s for a few reasons.
1. Because some commands may not output immediately
2. Some commands pause mid-way through output
3. General delay in getting data output
This allows for the collection of outputs properly as they are generated and a pause in case a command does not output immediately, pauses, or python catches up to the end of the available data
Using this keyword and changing the timeout is NOT recommended.
--vsm
Specifies to get ASR9K VSM specific outputs, without this option no VSM commands will be run
--minimal
Reduces the output of the comparer script so that only WARNINGs are output on the terminal and only a summary view like without this keyword are printed to the compare file.
Without minimal a summary of all commands whether there is an alarm raised or not will be printed, and in the compare file a full dump of all the 'relevant' data used for comparions which is very verbose
=======================
Output
=======================
Some output will be displayed on the screen, but this is kept to a minimum, only displaying differences or a summary for each command.
Outfiles will have the full outputs.
=========================
Bugs / Enhancements / etc
=========================
Contact [email protected] for any issues, please include terminal logs and the output files for faster debugging.
Don't see a feature or command you want in this tool, contact [email protected] preferably with examples.