Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Really Awesome New Cisco confIg Differ with git extensions and support for colorized emails!
Shell C
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Rancid is a "Really Awesome New Cisco confIg Differ" developed to
maintain CVS controlled copies of router configs.

*** The Following Information is Very Important ****
Rancid 2.3 introduces a new directory layout.  It has been changed to more
closely follow the standard path hierarchy, which is defined by the FHS
standard and autoconf, and/or make these locations more easily configurable
within rancid.

The obvious advantage of this is making rancid more easily packagable; i.e.:
NetBSD pkgsrc, FreeBSD port, Linux RPM, etc.

Please please please please read the UPGRADING file for more information.

The following is the packing list for Rancid.  .in is stripped from
the files below by configure with substitutions completed:

README		This file.
CHANGES		List of changes to Rancid.
Todo		Partial list of what needs to be done.	Environment settings needed.	Script designed to be run from cron calling control_rancid.
		Builds router list, calls rancid on each router and
		handles cvs routines.	chooses between rancid/[abefhjrx]rancid/cat5rancid.	Runs commands on cisco routers and processes the output.	Runs commands on baynet/nortel routers and processes the output.	Runs commands on ADC EZ-T3 muxes and processes the output.	Runs commands on Force10 routers and processes the output.	Runs commands on foundry switches and processes the output.	Runs commands on hp procurve switches and processes the output.	Runs commands on juniper routers and processes the output.	Runs commands on MRT daemons and processes the output.	Runs commands on netscreen routers and processes the output.	Runs commands on redback routers and processes the output.	Runs commands on extreme switches and processes the output.	Runs commands on cisco Cat switches and processes the output.	Expect script that logs into baynet/nortel routers either
		interactively, runs a set of commands, or runs another expect
		script.	Expect script that logs into routers either interactively,
		runs a set of commands, or runs another expect script.	Expect script that logs into ADC EZ-T3 muxes either
		interactively, runs a set of commands, or runs another expect
		script.	Expect script that logs into foundry switches.  Once foundry
		cleans up their bloody UI, clogin should do the job.	Expect script that logs into hp procurve switches either
		interactively, runs a set of commands, or runs another expect
		script.	Expect script that logs into juniper routers similarly to
		clogin.  It is not terribly robust, but mainly used for it's
		-c and -s options.
.cloginrc	TCL commands to set passwords, usernames etc. used by clogin
		and jlogin.		Parallel processing of commands - any commands.	Creates all of the CVS and config directories.
hpuifilter.c	HP procurve login filter - see end of hlogin(1).
etc/		Configuration file samples
man/		man pages
share/		Readmes, samples, utilities, contribs, etc

The following are included as part of the installation tools:	processed by configure to produce Makefiles
configure	GNU autoconf script
install-sh	GNU autoconf shell script to simulate BSD style install
mkinstalldirs	GNU autoconf shell script to make installation directories

rancid will also need to have the following packages:
cvs		Code revision system available from
gnudiff		gnudiff provides the uni-diff (-u) option.  If you do not have
		a diff that supports -u, configure will set-up rancid to use
		'diff -c' or 'diff -C'.
perl5		perl version 5 or greater available from
expect  We highly suggest that you stick to
		expect 5.24.1 (or so).  This seems to work best.  Note that
		you need to have the accompanying tcl &/ tk.
tcl		Required by expect.

Bill Fenner (now maintained by others) has a cgi script for interacting
with CVS repositories via a web interface.  This provides a great way to
view rancid diffs and full configs, especially for those unfamiliar with
cvs.  The package is not included, but can be found here:

Quick Installation Guide (an example):

1) ./configure [--prefix=<basedir>]
   By default, rancid will be installed under /usr/local/rancid (the default
   "prefix").  This can be overridden with the --prefix option.  E.g.:

	./configure --prefix=/home/rancid

   Rancid uses autoconf's "localstatedir" as the location of it's logs,
   CVS respository, and directories where it's groups are placed.  The user
   who will run rancid (from cron, etc) will need write access to these
   directories.  By default, this is <prefix>/var, or /home/rancid/var
   following the example above.

   We realize that this is not optimal, but it follows the standards.  We
   suggest that this be altered to include the package name, like so:

	./configure --prefix=/home/rancid \

   The user who will run rancid must have write permission in "localstatedir".

   See ./configure --help for other configure options.

2) make install

3) Modify <sysconfdir>/rancid.conf (e.g.: <basedir>/etc/rancid.conf).  The
   variable LIST_OF_GROUPS is a space delimited list of router "groups".
	LIST_OF_GROUPS="backbone aggregation switches"

4) Put .cloginrc in the home directory of the user who will run rancid.
   .cloginrc must be not be readable/writable/executable by "others",
   i.e.: .cloginrc must be mode 0600 or 0640.

5) Modify .cloginrc.

   Test to make sure that you can log into every router.

   Note: the juniper user you use *must* log into a cli shell (which
   is the default on a juniper).

   See the file cloginrc.sample, located in <datadir> (<basedir>/share/rancid),
   for examples and good starting point.  Also take a look at the cloginrc
   manual page, 'man -M <basedir>/man cloginrc'.

6) Modify /etc/aliases
   Rancid sends the diffs and other administrative emails to rancid-<GROUP>
   and problems to rancid-admin-<GROUP>, where <GROUP> is the "GROUP" of
   routers.  This way you can separate your backbone routers from your
   access routers or separate based upon network etc...  Different router
   uses forced different people being interested in router "groups" -
   thus this setup.  Make sure email to rancid-<GROUP> works.  /etc/aliases
   can be maintainable by Majordomo stuff, but make sure the user that
   runs rancid can post to the list.

   The Precedence header set to bulk or junk *hopefully* avoids replies from
   auto-responders and vacation type mail filters.

   The --enable-mail-plus option to configure will set each of the "rancid-"
   addresses mentioned above to "rancid+".  See sendmail's operation manual
   for more information on handling of '+'.

   The --enable-adminmail-plus configure option will set each of the
   "rancid-admin-" addresses mentioned above to "rancid-admin+".  If this
   option is not used, the value of --enable-mail-plus is assumed.  That is,
   the addresses will be "rancid+", if it is specified.

7) Run rancid-cvs.
   This creates all of the necessary directories and config files for
   each of the groups in LIST_OF_GROUPS and imports them into CVS.  This
   will also be run each time a new group is added.  Do not create the
   directories or CVS repository manually, allow rancid-cvs do it.  Also see
   'man -M <basedir>/man rancid-cvs'.

8) For each "group", modify the router.db file in the group directory.
   The file is of the form "router:mfg:state" where "router" is
   the name (we use FQDN) of the router, mfg is the manufacturer
   from the set of (cat5|cisco|juniper) (see router.db.5 for a complete
   list and description), and "state" is either up or down.  Each router
   listed as "up" will have the configuration grabbed.  Note: manufacturer
   cat5 is intended only for cisco catalyst switches running catalyst (not
   IOS) code.

   e.g.: <localstatedir>/<group>/router.db:

9) For first-time users or new installations, run bin/rancid-run (with no
   arguments) and check the resulting log file(s) (in logs/*) for errors.
   Repeat until there are no errors.

10) Put rancid-run in cron to be called however often you want it to
   run for each group (rancid-run [<GROUP>]).  If you run it less
   often than once/hour, check the setting of OLDTIME in etc/rancid.conf.
	# run config differ hourly
	1 * * * * <BASEDIR>/bin/rancid-run
	# clean out config differ logs
	50 23 * * * /usr/bin/find <localstatedir>/logs -type f -mtime +2 -exec rm {} \;

11) Note: If you are using any of these programs (other than
    rancid-run) out of cron, make sure that you set your $PATH
    correctly so that they work.  E.g.: if you are using clogin,
    it can call id, telnet, ssh, and/or rsh.

    configure already makes sure that $PATH is set correctly in
    etc/rancid.conf for rancid-run, so you could use the $PATH from there. e.g.:

	50 23 * * * . <sysconfdir>/rancid.conf; clogin -c 'sh vers' router

12) Send any bugs, suggestions or updates to
    See the web page at  We have
    created the standard mailing lists for those interested; and
    Subscribe by sending an email whose body contains "subscribe
    rancid-<announce or discuss>" to

    If you are reporting problems, please include the version of rancid,
    expect, and your OS in the email.

Problem with clogin/telnet hanging within rancid or scripts?

If you have experienced rancid (or more precisely, telnet) hanging on a
solaris 2.6 box; check to be sure you have the following two patches
installed (see showrev -p).  There may be more recent versions of these
patches and they are likely included with 2.7 and 2.8: 

Patch-ID# 105529-08
Keywords: security tcp rlogin TCP ACK FIN packet listen
Synopsis: SunOS 5.6: /kernel/drv/tcp patch

Patch-ID# 105786-11
Keywords: security ip tcp_priv_stream routing ip_enable_group_ifs ndd
Synopsis: SunOS 5.6: /kernel/drv/ip patch

Another possibile contributor is expect/tcl.  We've noticed that expect
5.24.1 (possibly 5.28.*) and whatever tcl happens to compile with it, 
seems to not exhibit this problem, while 5.32.* appears to on linux and
solaris but not on netbsd 1.5.

Also, for rancid 2.3 and later, changes were made to the login scripts
which use some more elaborate regexes that have failed with expect versions
prior to 5.40.  While 5.40 works, it still seems to need the patch offered
on the rancid web page.

See for additional notes on this.

Something went wrong with that request. Please try again.