rancid-run(1) [debian man page]
rancid-run(1) General Commands Manual rancid-run(1) NAME
rancid-run - run rancid for each of the groups SYNOPSIS
rancid-run [-V] [-f rancid.conf] [-f rancid.conf] [-m mail_rcpt] [-r device_name] [group [group ...]] DESCRIPTION
rancid-run is a sh(1) script to run rancid(1) for a set of rancid group(s). rancid-run reads rancid.conf(5) to configure itself, then uses control_rancid(1) to run rancid(1) for each rancid group. The set of rancid groups can either be provided as command-line arguments or via the LIST_OF_GROUPS variable in rancid.conf(5), if the group argument is omitted. A lock file is maintained per-group to prevent simultaneous runs for a given group by rancid-run(1). The lock file will be named .<group>.run.lock and will be located in /var/lib/rancid. A log file is produced under $LOGDIR/logs for each rancid group processed. The file name will be <group>.YYYYMMDD.HHMMSS (year month day . hour minute second). rancid-run is normally used to run rancid from cron(8). For example: 0 * * * * /usr/local/rancid/bin/rancid-run The command-line options are as follows: -V Prints package name and version strings. -f rancid.conf Specify an alternate configuration file. -m mail_rcpt Specify the recipient of diff mail, which is normally rancid-<group>. The argument may be a single address, multiple comma separated addresses, or -m may be specified multiple times. -r device_name Run rancid for a single device, device_name. device_name should be name, as it appears in a group's router.db. The device must be marked "up". If a group is not specified on the command-line, rancid will be run against any group in which the device_name appears. The -r option alters the subject line of the diff mail. It will begin with <group name>/<device name> rather than just the group name alone. ENVIRONMENT
rancid-run utilizes the following environment variables from rancid.conf(5). BASEDIR Location of group directories, etc. This is set to the "localstatedir" by the configure script at installation time. LIST_OF_GROUPS List of rancid groups to collect. PATH Search path for utilities. TMPDIR Directory to hold temporary files. ERRORS
If rancid fails to run or collect a device's configuration, the particular group's log file (mentioned above) should be consulted. Any errors produced by the revision control system (CVS or Subversion) or any of the rancid scripts should be included there, whether they be a botched cvs tree, login authentication failure, rancid configuration error, etc. If the log file produces no clues, the next debugging step should be run the commands manually. For example, can the user who runs rancid login to the device with 'clogin hostname', and so on. FILES
$BASEDIR/etc/rancid.conf rancid-run configuration file. SEE ALSO
control_rancid(1), rancid.conf(5), router.db(5) 5 October 2006 rancid-run(1)
Check Out this Related Man Page
rancid_intro(1) General Commands Manual rancid_intro(1) NAME
rancid_intro - introduction to the Really Awesome New Cisco confIg Differ INTRODUCTION
rancid is really more than just a Cisco configuration differ. It handles several different device's configurations; currently including Alteon, Arista, Bay Networks (Nortel), Cisco, Extreme, F5 BigIP, Force10, Fortinet, Foundry, HP Procurve switches, Hitachi, Juniper Routers and edge (ERX) routers, Lucent TNT, MRTd daemon, Netscalar load balancers, Netscreen firewalls, Procket, Redback, SMC switches, Zebra routing software, and the ADC-Kentrox EZ-T3 mux. rancid uses an expect script to login to each of 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 chassis temperature and easily reverse-able passwords. Named after the device's name in the group's configuration file (router.db), 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 rancid.conf(5) for more information on <group>s. 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 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, router.db. Lastly, all the updated files are checked into the revision control system (CVS or Subversion). Additional utilities, including a looking glass, come with rancid. See rancid's share directory ( share/rancid). 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. 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 In this example, we see that a Gigabit Ethernet linecard was removed from slot 6. However, 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. GETTING STARTED
Installation instructions are included in the distribution's top-level directory in the README file (which will be installed in share/rancid). Once the installation is complete, start by reading the man pages listed below or follow the basic instructions included in the README file. See http://www.shrubbery.net/rancid for information on new versions, mail lists, etc. ADDING NEW GROUPS
Follow this procedure for adding new groups: o Update the LIST_OF_GROUPS variable in etc/rancid.conf (see rancid.conf(5)). o Run rancid-cvs(1). o Update the system's mail aliases file /etc/aliases (see rancid.conf(5)). SEE ALSO
clogin(1), cloginrc(5), control_rancid(1), lg_intro(1), rancid(1), rancid-run(1), rancid.conf(5), router.db(5) 14 july 2009 rancid_intro(1)