1control_rancid(1) General Commands Manual control_rancid(1)
2
3
4
6 control_rancid - run rancid for devices of a group
7
9 control_rancid [-V] [-c commit_msg] [-f con‐
10 fig_file] [-m mail_rcpt] [-r device_name] group
11
13 control_rancid is a sh(1) script to parse a group's router.db(5), run
14 rancid for each of the devices, possibly re-run rancid for devices that
15 failed collection, e-mail diffs, and e-mail error reports.
16
17 control_rancid also creates and/or re-creates the .cvsignore/.gitignore
18 files for each group. For the configs sub-directory, it includes
19 ".old", where a user may keep files they would like to be ignored.
20
21 The command-line options are as follows:
22
23 -V Prints package name and version strings.
24
25 -c commit_msg
26 Specify an alternative SCM commit message.
27
28 -f group_config_file
29 Specify an alternative rancid.conf. The global rancid.conf file
30 is read by rancid-run, which calls control_rancid for each
31 group, and control_rancid reads the group-specific rancid.conf,
32 thereby overriding the global file.
33
34 The group-specific rancid.conf may not exist.
35
36 Default: <BASEDIR>/<group>/rancid.conf
37
38 -m mail_rcpt
39 Specify the recipient of diff mail, which is normally
40 rancid-<group>. The argument may be a single address, multiple
41 comma separated addresses, or -m may be specified multiple
42 times.
43
44 -r device_name
45 Specify the name, as it appears in the router.db, of a
46 particular device to collect and generate diffs for. The device
47 must be marked "up".
48
49 The -r option alters the subject line of the diff mail. It will
50 begin with <group name>/<device name> rather than just the group
51 name alone.
52
53 control_rancid is normally (and best) run via rancid-run(1) which
54 provides a locking mechanism on a group basis and saves output in a log
55 file for each group.
56
58 rancid-run(1), rancid.conf(5), router.db(5)
59
60
61
62 22 December 2016 control_rancid(1)