Skip to content

Commit e5f808d

Browse files
authored
Update README.md
1 parent 1a6f1b9 commit e5f808d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,24 @@ Dell (FTOS)
88
<b><h3>What is InterStat?</h3></b>
99
<b>InterStat</b> is a simple python script for saving the output of the current interface status from a list of devices. It is using the libary paramiko for building up a ssh connection to the network devices (switches, routers,...) which are defined in a list of ip adresses.
1010

11-
After successful connection to a device, the script collect some device informations like privilege mode, paging, brand hostname and of course the interface status. The device information will just printed out to the command line and only the interface status output will be saved to a file called the hostname of the device.
11+
After successful connection to a device, the script collect some device informations like check privilege mode, paging, brand, hostname and of course the status of the interfaces. The device information will just printed out to the shell and only the interface status output will be saved to a file named like the hostname of the device.
1212

1313

1414
<b><h3>How to use?</h3></b>
15-
Before you can start the script, you have to change some parameters. There are three variables you have to look for.
15+
Before you can start the script, maybe you have to change some parameters. There are three variables you have to look for.
1616

1717
<b><h4>1. SSH-Port </h4></b>
1818
By default the ssh port is <b>22</b>. If you want to take another port for the ssh connection, you have to edit the <code><b>line 38</b></code> which defines the ssh port. Change the <b>22</b> to the port you prefer.
1919

2020
<code>port = ('22')</code>
2121

2222
<b><h4>2. Destination path </h4></b>
23-
By default the destination path is <b>"G:/InterStat/"</b>. Normally you want to costumize the path where the files should be saved. In this reason you have to edit the <code><b>line 41</b></code> which defines the path to the destination directory. Change the path to the directory you prefer.
23+
By default the destination path is <b>G:/InterStat/</b>. Normally you want to costumize the path where the files should be saved. In this reason you have to edit the <code><b>line 41</b></code> which defines the path to the destination directory.
2424

2525
<code>path = (r'G:/InterStat/')</code>
2626

2727
<b><h4>3. IP-List </h4></b>
28-
By default the ip list for the devices is named <b>"ip_list.txt</b>. Maybe you want to rename the filename. For this case you have to edit the <code><b>line 44</b></code>, <code><b>line 45</b></code> and <code><b>line 57</b></code> which defines the the filename. Change the filename <b>"ip_list.txt</b> you prefer.
28+
By default the ip list for the devices is named <b>ip_list</b>. Maybe you want to change the filename. For this case you have to edit the <code><b>line 44</b></code>, <code><b>line 45</b></code> and <code><b>line 57</b></code> which defines the ip list.
2929

3030
<code>with open('ip_list.txt', 'r') as ip:</code><br>
3131
and<br>
@@ -45,7 +45,7 @@ After you changed the parameters and the directories are defined, you can start
4545

4646
4. The script will disable the paging function to get the maximum output.
4747

48-
5. To get the hostname of the device the script will find out with the <b>show version</b> command, which brand the device is of. By default the brand could be cisco (IOS, IOS-XE, NX-OS, ...) and dell (Force 10). Depending on which one, the script will prompt the <b>show run | include hostname</b> or <b>show run | find hostname</b> command to pick out the hostname of the device.
48+
5. To get the hostname of the device the script will ask the device with the <b>show version</b> command, which brand the device is of. By default the brand could be cisco (IOS, IOS-XE, NX-OS, ...) and dell (Force 10). Depending on which one, the script will prompt the <b>show run | include hostname</b> or <b>show run | find hostname</b> command to pick out the hostname of the device.
4949

5050
6. After that the main function will start his work. The <b>interface status</b> command will be promt and the output will be saved to a textfile with the hostname fo the device as filename to the directory you defined at the start. If this succeed the script will pick the next ip address of the ip list and repeat the process.
5151

0 commit comments

Comments
 (0)