diff options
author | Tar Committer <tar@ocjtech.us> | 2001-02-05 17:47:18 +0000 |
---|---|---|
committer | Tar Committer <tar@ocjtech.us> | 2001-02-05 17:47:18 +0000 |
commit | b88919bea4b222a616adbdd2b82fc262a14afc8d (patch) | |
tree | a75da71b0e2f905f35d2d7cbfd161df97a3d2c63 /man/rancid_intro.1 | |
parent | 25c2b7c2c8a333b276c3499bcce004137d4b4fe0 (diff) | |
download | rancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.tar.gz rancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.tar.xz rancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.zip |
Imported from rancid-2.1.tar.gz.rancid-2.1
Diffstat (limited to 'man/rancid_intro.1')
-rw-r--r-- | man/rancid_intro.1 | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/man/rancid_intro.1 b/man/rancid_intro.1 new file mode 100644 index 0000000..3d866c1 --- /dev/null +++ b/man/rancid_intro.1 @@ -0,0 +1,113 @@ +.\" +.hys 50 +.TH "rancid_intro" "1" "22 Jan 2001" +.SH NAME +rancid_intro \- introduction to the Really Awesome New Cisco confIg Differ +.SH INTRODUCTION +.B rancid +is really more than just a Cisco configuration differ. It handles several +different device's configurations; currently including Cisco, Foundry, +Juniper, Redback, and the ADC-Kentrox EZ-T3 mux. +.PP +.B rancid +uses an expect script to login to a list of devices and run a set of +commands for that device-type and collects the output. The output +is run through some filtering to summarize, reformat, and/or snip +unwanted or security related data such as temperature and easily reverse-able +passwords. +.PP +Named after the device's name in the group's configuration file, the +resulting files are saved in the directory <group>/configs. Except for the +data filtered from the configuration file for security reasons, such as +reversable passwords, these files are suitable for loading directly to restore +a lost configuration. See +.BR env (5) +for more information on <group>'s. +.PP +After filtering, a uni-diff (see diff(1)) of the result is produced +for each of the devices in a group against that of the previous run of +.B rancid +and is e-mailed to that group's mail list, "rancid-<group>". This e-mail +will also include any differences of the device list in the group's +configuration file, +.IR "router.db". +.PP +Lastly, all the updated files are checked into the CVS repository. +.PP +Additional utilities, including a looking glass, can be found under +the util sub-directory. +.SH "EXAMPLE E-MAIL" +Below is a sample of a uni-diff produced from the group "shrubbery" +for the device named dfw.shrubbery.net, which happens to be a Cisco GSR. +.PP +.nf +From: rancid +To: rancid-shrubbery@shrubbery.net +Subject: shrubbery router config diffs +Precedence: bulk + +Index: configs/dfw.shrubbery.net +=================================================================== +retrieving revision 1.144 +diff -u -4 -r1.144 dfw.shrubbery.net +@@ -57,14 +57,8 @@ + !Slot 2/MBUS: hvers 1.1 + !Slot 2/MBUS: software 01.36 (RAM) (ROM version is 01.33) + !Slot 2/MBUS: 128 Mbytes DRAM, 16384 Kbytes SDRAM + ! +- !Slot 6: 1 Port Gigabit Ethernet +- !Slot 6/PCA: part 73-3302-03 rev C0 ver 3, serial CAB031216OL +- !Slot 6/PCA: hvers 1.1 +- !Slot 6/MBUS: part 73-2146-07 rev B0 dev 0, serial CAB031112SB +- !Slot 6/MBUS: hvers 1.2 +- !Slot 6/MBUS: software 01.36 (RAM) (ROM version is 01.33) + !Slot 7: Route Processor + !Slot 7/PCA: part 73-2170-03 rev B0 ver 3, serial CAB024901SI + !Slot 7/PCA: hvers 1.4 + !Slot 7/MBUS: part 73-2146-06 rev A0 dev 0, serial CAB02060044 +.fi +.PP +In this example, we see that a Gigabit Ethernet linecard was removed +from slot 6. Since this data is collected from "show" commands on the +router, it could just as easily be that the card crashed so the RP +can not communicate with it to collect information. +.SH "GETTING STARTED" +Installation instructions are included in the distribution's top-level +directory in the README file. Once the installation is complete, start +by reading the man pages listed below or follow the basic instructions +included in the README file. +.PP +See http://www.shrubbery.net/rancid for information on new versions, +mail lists, etc. +.B rancid +can be retrieved from ftp://ftp.shrubbery.net/pub/rancid. +.SH "ADDING NEW GROUPS" +Follow this procdure for adding new groups: +.TP +o +Update the +.IR LIST_OF_GROUPS +variable in +.IR bin/env +(see +.BR env (5)). +.TP +o +Run +.BR create_cvs (1). +.TP +o +Update the system's mail aliases file +.IR /etc/aliases ( +see +.BR env (5)). +.\" +.SH "SEE ALSO" +.BR cloginrc (5), +.BR clogin (1), +.BR control_rancid (1), +.BR env (5), +.BR do-diffs (1), +.BR lg_intro (1), +.BR router.db (5) , +.BR rancid (1) |