router.db - rancid group configuration file
contains information for devices which are members of a 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:
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:
- A Cisco Anomaly Guard Module (aka Riverhead). Suspect that
at some point the UI will become more cisco-like and it can be merged with
the IOS rancid module.
- An Alteon WebOS switches.
- An Arista Networks device.
- An Avocent Cyclades console server.
- A Bay Networks router.
- A F5 device running BIG-IP >= v11.
- A Cisco catalyst series 5000 and 4000 switches (i.e.:
running the catalyst OS, not IOS).
- A Ciena Waveserver.
- A Cisco router, PIX, or switch such as the 3500XL or 6000
running IOS (or IOS-like) OS, but not IOS-XR, NX-OS or Cisco small
- A Cisco small business devices.
- A Cisco Nexus switch/router.
- A Cisco device running IOS-XR.
- A Cisco Wireless Controller versions up to 4.
- A Cisco Wireless Controller versions 5 and above.
- A Cisco content services switch.
- An enterasys NAS. This is currently an alias for the
riverstone device type.
- A Juniper E-series edge router.
- A Dell switch. Known working models are DES-3010F,
DES-3052P, DES-3526, and DES-3550. Note that Dell OEMs some equipment and
has purchased some companies, so a Dell product may not work with the dell
rancid module but may work with smc or force10.
- An Extreme switch.
- An ADC-Kentrox EZ-T3 mux.
- A F5 BigIP switch.
- A Force10 router.
- A Fortinet firewall.
- A Foundry router, switch, or router-switch. This includes
HP Procurve switches that are OEMs of Foundry products, such as the
- A Hitachi router.
- A HP Procurve switch such as the 2524, 4108 or J9086A (aka.
2610) procurve switches, J9091A, and J8698A. Also see the foundry
- A Juniper router.
- A Mikrotik router.
- A host running the (Merit) MRTd daemon.
- A MRV optical device; including NC316, OptiSwitch 904,
OptiSwitch 906G, OptiSwitch 912C, OptiSwitch 940.
- A Netscalar load balancer.
- A Netscreen firewall.
- A Palo Alto Networks device.
- A Procket router.
- A Redback router, NAS, etc.
- A Riverstone NAS or Cabletron (starting with version
- A SMC switch, which also account for some Dell OEMs.
Including Dell PowerConnect 35xx (3524, 3524P, 3548, 3548P) and 7048.
- A Nokia (Alcatel-Lucent) router, such as the 7750 SR.
- A Xirrus array.
- Zebra routing software.
- 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
A ``#'' at the beginning of a line is a comment; the entire line is ignored.
If a device is deleted from the router.db
file, then rancid
clean up by removing the device's config file from
. 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
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