1rancid-run(1)               General Commands Manual              rancid-run(1)
2
3
4

NAME

6       rancid-run - run rancid for each of the groups
7

SYNOPSIS

9       rancid-run                [-V]                [-f rancid.conf] [-f ran‐
10       cid.conf] [-m mail_rcpt] [-r device_name] [group [group ...]]
11

DESCRIPTION

13       rancid-run is a sh(1) script to run  rancid(1)  for  a  set  of  rancid
14       group(s).
15
16       rancid-run   reads   rancid.conf(5)  to  configure  itself,  then  uses
17       control_rancid(1) to run rancid(1) for each rancid group.  The  set  of
18       rancid  groups  can either be provided as command-line arguments or via
19       the LIST_OF_GROUPS variable in rancid.conf(5), if the group argument is
20       omitted.
21
22       A  lock file is maintained per-group to prevent simultaneous runs for a
23       given  group  by  rancid-run(1).   The  lock   file   will   be   named
24       .<group>.run.lock and will be located in $TMPDIR (see below).
25
26       A  log  file  is  produced  under  $LOGDIR/logs  for  each rancid group
27       processed.  The file name will be <group>.YYYYMMDD.HHMMSS  (year  month
28       day . hour minute second).
29
30       rancid-run is normally used to run rancid from cron(8).  For example:
31
32                 0 * * * *      /usr/local/rancid/bin/rancid-run
33
34       The command-line options are as follows:
35
36       -V     Prints package name and version strings.
37
38       -f rancid.conf
39              Specify an alternate configuration file.
40
41       -m mail_rcpt
42              Specify   the   recipient   of  diff  mail,  which  is  normally
43              rancid-<group>.  The argument may be a single address,  multiple
44              comma  separated  addresses,  or  -m  may  be specified multiple
45              times.
46
47       -r device_name
48              Run rancid for a single device, device_name.  device_name should
49              be  name, as it appears in a group's router.db.  The device must
50              be marked "up".  If a group is not  specified  on  the  command-
51              line,  rancid  will  be  run  against  any  group  in  which the
52              device_name appears.
53
54              The -r option alters the subject line of the diff mail.  It will
55              begin with <group name>/<device name> rather than just the group
56              name alone.
57

ENVIRONMENT

59       rancid-run  utilizes   the   following   environment   variables   from
60       rancid.conf(5).
61
62       BASEDIR
63              Location  of  group  directories,  etc.   This  is  set  to  the
64              "localstatedir" by the configure script at installation time.
65
66       LIST_OF_GROUPS
67              List of rancid groups to collect.
68
69       PATH   Search path for utilities.
70
71       TMPDIR Directory to hold temporary and lock files.
72

ERRORS

74       If rancid fails  to  run  or  collect  a  device's  configuration,  the
75       particular group's log file (mentioned above) should be consulted.  Any
76       errors produced by the revision control system (CVS or  Subversion)  or
77       any  of  the rancid scripts should be included there, whether they be a
78       botched cvs tree, login authentication  failure,  rancid  configuration
79       error, etc.  If the log file produces no clues, the next debugging step
80       should be run the commands manually.  For example,  can  the  user  who
81       runs rancid login to the device with 'clogin hostname', and so on.
82

FILES

84       $BASEDIR/etc/rancid.conf
85              rancid-run configuration file.
86

SEE ALSO

88       control_rancid(1), rancid.conf(5), router.db(5)
89
90
91
92                                5 October 2006                   rancid-run(1)
Impressum