rancid_intro(1)

1rancid_intro(1)             General Commands Manual            rancid_intro(1)
2
3
4

NAME

6       rancid_intro  -  introduction  to  the  Really Awesome New Cisco confIg
7       Differ
8

INTRODUCTION

10       rancid is really more than  just  a  Cisco  configuration  differ.   It
11       handles  several different device's configurations; currently including
12       Alteon, Arista,  Bay  Networks  (Nortel),  Cisco,  Extreme,  F5  BigIP,
13       Force10,  Fortinet, Foundry, HP Procurve switches, Hauwei VRP, Hitachi,
14       Juniper Routers and edge (ERX) routers, MRTd daemon, Microtik  routers,
15       Netscalar  load  balancers,  Netscreen firewalls, Procket, Redback, SMC
16       switches, Xirrus arrays, Zebra routing software,  and  the  ADC-Kentrox
17       EZ-T3 mux.
18
19       rancid uses an expect script to login using ssh, telnet, or rsh to each
20       of a list of devices and run a set of commands for that device-type and
21       collects  the  output.   The  output  is  run through some filtering to
22       summarize, reformat, and/or snip unwanted or security related data such
23       as chassis temperature and easily reverse-able passwords.
24
25       Named  after  the  device's  name  in  the  group's  configuration file
26       (router.db),  the  resulting  files  are   saved   in   the   directory
27       <group>/configs.   Except  for the data filtered from the configuration
28       file for security reasons, such as reversable  passwords,  these  files
29       are suitable for loading directly to restore a lost configuration.  See
30       rancid.conf(5) for more information on <group>s.
31
32       After filtering, a uni-diff (see diff(1)) of the result is produced for
33       each  of  the  devices  in  a group against that of the previous run of
34       rancid and is e-mailed to that  group's  mail  list,  "rancid-<group>".
35       This e-mail will also include any differences of the device list in the
36       group's configuration file, router.db.
37
38       Lastly, all the updated files are checked  into  the  revision  control
39       system  (CVS,  Subversion, or git).  And, administrative messages, such
40       as collections that are failing for longer than OLDTIME, are mailed  to
41       "rancid-admin-<group>".
42
43       Additional utilities, including a looking glass, come with rancid.  See
44       rancid's share directory ( share/rancid).
45

EXAMPLE E-MAIL

47       Below is a sample of a uni-diff produced from the group "shrubbery" for
48       the device named dfw.shrubbery.net, which happens to be a Cisco GSR.
49
50       From: rancid
51       To: rancid-shrubbery@shrubbery.net
52       Subject: shrubbery router config diffs
53       Precedence: bulk
54
55       Index: configs/dfw.shrubbery.net
56       ===================================================================
57       retrieving revision 1.144
58       diff -u -4 -r1.144 dfw.shrubbery.net
59       @@ -57,14 +57,8 @@
60         !Slot 2/MBUS: hvers 1.1
61         !Slot 2/MBUS: software 01.36 (RAM) (ROM version is 01.33)
62         !Slot 2/MBUS: 128 Mbytes DRAM, 16384 Kbytes SDRAM
63         !
64       - !Slot 6: 1 Port Gigabit Ethernet
65       - !Slot 6/PCA: part 73-3302-03 rev C0 ver 3, serial CAB031216OL
66       - !Slot 6/PCA: hvers 1.1
67       - !Slot 6/MBUS: part 73-2146-07 rev B0 dev 0, serial CAB031112SB
68       - !Slot 6/MBUS: hvers 1.2
69       - !Slot 6/MBUS: software 01.36 (RAM) (ROM version is 01.33)
70         !Slot 7: Route Processor
71         !Slot 7/PCA: part 73-2170-03 rev B0 ver 3, serial CAB024901SI
72         !Slot 7/PCA: hvers 1.4
73         !Slot 7/MBUS: part 73-2146-06 rev A0 dev 0, serial CAB02060044
74
75       In  this  example,  we see that a Gigabit Ethernet linecard was removed
76       from slot 6.   However,  since  this  data  is  collected  from  "show"
77       commands  on  the  router,  it  could  just  as easily be that the card
78       crashed so the RP can not communicate with it to collect information.
79

GETTING STARTED

81       Installation instructions are included in the distribution's  top-level
82       directory in the README file (which will be installed in share/rancid).
83       Once the installation is complete,  start  by  reading  the  man  pages
84       listed  below  or  follow the basic instructions included in the README
85       file.
86
87       See http://www.shrubbery.net/rancid for information  on  new  versions,
88       mail lists, etc.
89

ADDING NEW GROUPS

91       Follow this procedure for adding new groups:
92
93       o      Update  the  LIST_OF_GROUPS  variable  in  etc/rancid.conf  (see
94              rancid.conf(5)).
95
96       o      Run rancid-cvs(1).
97
98       o      Update  the  system's  mail  aliases  file   /etc/aliases   (see
99              rancid.conf(5)).
100

NAME

INTRODUCTION

EXAMPLE E-MAIL

GETTING STARTED

ADDING NEW GROUPS

SEE ALSO