1router.db(5) File Formats Manual router.db(5)
2
6 router.db - rancid group configuration file
7
9 router.db contains information for devices which are members of a
10 rancid group. control_rancid(1) reads this file to compile a list of
11 devices which it should collect.
12
14 One device is listed per-line, where the syntax is:
15 <device_name>;<device_type>;<state>[;comments]
17 For example:
19 scooby.shrubbery.net;cisco;up
20 The fields are as follows:
22 <device_name>
24 The name of the device, which must resolve via gethostbyname,
25 used as the argument to telnet(1), rsh(1), or ssh(1), to connect
26 to the device. Once converted to lower-case, this also becomes
27 the name of the file used to store the configuration under
28 $BASEDIR/<group>/configs.
29 Experience has shown that using the device's FQDN (Fully
31 Qualified Domain Name) works best, as in the example above.
32 <device_type>
34 The type of device from the set:
35 agm A Cisco Anomoly Guard Module (aka Riverhead). Suspect
37 that at some point the UI will become more cisco-like
38 and it can be merged with the IOS rancid module.
39 alteon An Alteon WebOS switches.
41 arcos An Arrcus router.
43 arista An Arista Networks device.
45 avocent
47 An Avocent Cyclades console server.
48 baynet A Bay Networks router.
50 bigip A F5 device running BIG-IP >= v11.
52 cat5 A Cisco catalyst series 5000 and 4000 switches (i.e.:
54 running the catalyst OS, not IOS).
55 ciena-ws
57 A Ciena Waveserver.
58 cisco A Cisco router, PIX, or switch such as the 3500XL or
60 6000 running IOS (or IOS-like) OS, but not IOS-XR, NX-OS
61 or Cisco small business devices.
62 cisco-sb
64 A Cisco small business devices.
65 cisco-nx
67 A Cisco Nexus switch/router.
68 cisco-xr
70 A Cisco device running IOS-XR.
71 cisco-wlc4
73 A Cisco Wireless Controller versions up to 4.
74 cisco-wlc5
76 A Cisco Wireless Controller versions 5 and above.
77 css A Cisco content services switch.
79 enterasys
81 An enterasys NAS. This is currently an alias for the
82 riverstone device type.
83 erx A Juniper E-series edge router.
85 fss2 A Fujitsu FSS2/1finity device.
87 dell A Dell switch. Known working models are DES-3010F,
89 DES-3052P, DES-3526, and DES-3550. Note that Dell OEMs
90 some equipment and has purchased some companies, so a
91 Dell product may not work with the dell rancid module
92 but may work with smc or force10.
93 extreme
95 An Extreme switch.
96 ezt3 An ADC-Kentrox EZ-T3 mux.
98 f5 A F5 BigIP switch.
100 force10
102 A Force10 router.
103 fortigate
105 A Fortinet firewall.
106 fortigate-full
108 A Fortinet firewall with all defaults shown.
109 foundry
111 A Foundry router, switch, or router-switch. This
112 includes HP Procurve switches that are OEMs of Foundry
113 products, such as the HP9304M.
114 hitachi
116 A Hitachi router.
117 hp A HP Procurve switch such as the 2524, 4108 or J9086A
119 (aka. 2610) procurve switches, J9091A, and J8698A. Also
120 see the foundry type.
121 juniper
123 A Juniper router.
124 mikrotik
126 A Mikrotik router.
127 mrtd A host running the (Merit) MRTd daemon.
129 mrv A MRV optical device; including NC316, OptiSwitch 904,
131 OptiSwitch 906G, OptiSwitch 912C, OptiSwitch 940.
132 netscaler
134 A Netscaler load balancer.
135 netscreen
137 A Netscreen firewall.
138 paloalto
140 A Palo Alto Networks device.
141 redback
143 A Redback router, NAS, etc.
144 riverstone
146 A Riverstone NAS or Cabletron (starting with version
147 ~9.0.3) router.
148 smc A SMC switch, which also account for some Dell OEMs.
150 Including Dell PowerConnect 35xx (3524, 3524P, 3548,
151 3548P) and 7048.
152 sros A Nokia (Alcatel-Lucent) router, such as the 7750 SR.
154 xirrus A Xirrus array.
156 zebra Zebra routing software.
158 <state>
160 The state is either "up", or some other arbitrary value, e.g.
161 "down". If the device is not marked "up" the device's
162 configuration will not be collected. It is highly recommended
163 that comments are made for any router not listed as up, so as to
164 indicate the reason a router is not to be polled, e.g.:
165 dial1.paris;cisco;up;
167 core1.paris;cisco;down;in testing until 5/5/2001.
168 core2.paris;cisco;ticketed;Ticket 6054234, 5/3/2001
169 border1.paris;juniper;up;
170 The script "downreport" in util/ can be used to produce a report
172 of routers in router.db that are not marked "up".
173 [comments]
175 Freeform string to describe the current state of the router.
176 A ``#'' at the begining of a line is a comment; the entire line is
178 ignored.
179 If a device is deleted from the router.db file, then rancid will clean
181 up by removing the device's config file from $BASEDIR/<group>/configs.
182 The device will be removed from the revision control system. It is
183 possible, in most cases, to resurrect or check-out copies of deleted
184 device configurations.
185
187 $BASEDIR/<group>/router.db
188 Configuration file described here, where <group> is a device
189 group name defined in the variable LIST_OF_GROUPS within
190 $BASEDIR/etc/rancid.conf.
191
193 control_rancid(1), rancid(1), rancid.conf(5)
194
196 In RANCID releases prior to 3.0, router.db used colons (:) as its field
197 separator. This was changed to allow IPv6 addresses to be used in
198 router.db.
199 12 July 2019 router.db(5)