12 July 2019
router.db - rancid group configuration file
router.db contains information for devices which are members of a rancid group. control_rancid(1) reads this file to compile a list of devices which it should collect.
One device is listed per-line, where the syntax is:
A ‘‘#’’ at the beginning of a line is a comment; the entire line is ignored.
The fields are as follows:
|The name of the device, which must resolve via gethostbyname , used as the argument to telnet(1), rsh(1), or ssh(1), to connect to the device. Once converted to lower-case, this also becomes the name of the file used to store the configuration under $BASEDIR/<group>/configs.
Experience has shown that using the device’s FQDN (Fully Qualified Domain Name) works best, as in the example above.
|The type of device from the set:
|The state is either "up", or some other arbitrary value, e.g. "down". If the device is not marked "up" the device’s configuration will not be collected. It is highly recommended that comments are made for any router not listed as up, so as to indicate the reason a router is not to be polled, e.g.:
core1.paris;cisco;down;in testing until 5/5/2001.
core2.paris;cisco;ticketed;Ticket 6054234, 5/3/2001
The script "downreport" in util/ can be used to produce a report of routers in router.db that are not marked "up".
|Freeform string to describe the current state of the router.|
If a device is deleted from the router.db file, then rancid will clean up by removing the device’s config file from $BASEDIR/<group>/configs. The device will be removed from the revision control system. It is possible, in most cases, to resurrect or check-out copies of deleted device configurations.
|Configuration file described here, where <group> is a device group name defined in the variable LIST_OF_GROUPS within $BASEDIR/etc/rancid.conf.|
In RANCID releases prior to 3.0, router.db used colons (:) as its field separator. This was changed to allow IPv6 addresses to be used in router.db.