rancid-run(1)

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]                [-c commit_msg] [-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       -c commit_msg
39              Specify an alternative SCM commit message.
40
41       -f rancid.conf
42              Specify an alternate configuration file.
43
44       -m mail_rcpt
45              Specify   the   recipient   of  diff  mail,  which  is  normally
46              rancid-<group>.  The argument may be a single address,  multiple
47              comma  separated  addresses,  or  -m  may  be specified multiple
48              times.
49
50       -r device_name
51              Run rancid for a single device, device_name.  device_name should
52              be  name, as it appears in a group's router.db.  The device must
53              be marked "up".  If a group is not  specified  on  the  command-
54              line,  rancid  will  be  run  against  any  group  in  which the
55              device_name appears.
56
57              The -r option alters the subject line of the diff mail.  It will
58              begin with <group name>/<device name> rather than just the group
59              name alone.
60

ENVIRONMENT

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

ERRORS

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

FILES

88       $BASEDIR/etc/rancid.conf
89              rancid-run configuration file.
90

CAVEATS

95       DO NOT leave temporary files in  the  <group  name>/configs  directory,
96       they WILL be removed by control_rancid(1).
97
98
99
100                               22 December 2016                  rancid-run(1)