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 Anomaly 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 baynet A Bay Networks router.
47 bigip A F5 device running BIG-IP >= v11.
49 cat5 A Cisco catalyst series 5000 and 4000 switches (i.e.:
51 running the catalyst OS, not IOS).
52 ciena-ws
54 A Ciena Waveserver.
55 cisco A Cisco router, PIX, or switch such as the 3500XL or
57 6000 running IOS (or IOS-like) OS, but not IOS-XR, NX-OS
58 or Cisco small business devices.
59 cisco-sb
61 A Cisco small business devices.
62 cisco-nx
64 A Cisco Nexus switch/router.
65 cisco-xr
67 A Cisco device running IOS-XR.
68 cisco-wlc4
70 A Cisco Wireless Controller versions up to 4.
71 cisco-wlc5
73 A Cisco Wireless Controller versions 5 and above.
74 css A Cisco content services switch.
76 enterasys
78 An enterasys NAS. This is currently an alias for the
79 riverstone device type.
80 erx A Juniper E-series edge router.
82 fss2 A Fujitsu FSS2/1finity device.
84 dell A Dell switch. Known working models are DES-3010F,
86 DES-3052P, DES-3526, and DES-3550. Note that Dell OEMs
87 some equipment and has purchased some companies, so a
88 Dell product may not work with the dell rancid module
89 but may work with smc or force10.
90 extreme
92 An Extreme switch.
93 ezt3 An ADC-Kentrox EZ-T3 mux.
95 f5 A F5 BigIP switch.
97 force10
99 A Force10 router.
100 fortigate
102 A Fortinet firewall.
103 fortigate-full
105 A Fortinet firewall with all defaults shown.
106 foundry
108 A Foundry router, switch, or router-switch. This
109 includes HP Procurve switches that are OEMs of Foundry
110 products, such as the HP9304M.
111 hitachi
113 A Hitachi router.
114 hp A HP Procurve switch such as the 2524, 4108 or J9086A
116 (aka. 2610) procurve switches, J9091A, and J8698A. Also
117 see the foundry type.
118 juniper
120 A Juniper router.
121 mrtd A host running the (Merit) MRTd daemon.
123 mrv A MRV optical device; including NC316, OptiSwitch 904,
125 OptiSwitch 906G, OptiSwitch 912C, OptiSwitch 940.
126 netscaler
128 A Netscaler load balancer.
129 netscreen
131 A Netscreen firewall.
132 paloalto
134 A Palo Alto Networks device.
135 redback
137 A Redback router, NAS, etc.
138 riverstone
140 A Riverstone NAS or Cabletron (starting with version
141 ~9.0.3) router.
142 routeros
144 A Mikrotik RouterOS router.
145 smc A SMC switch, which also account for some Dell OEMs.
147 Including Dell PowerConnect 35xx (3524, 3524P, 3548,
148 3548P) and 7048.
149 sros A Nokia (Alcatel-Lucent) router, such as the 7750 SR.
151 xirrus A Xirrus array.
153 zebra Zebra routing software.
155 <state>
157 The state is either "up", or some other arbitrary value, e.g.
158 "down". If the device is not marked "up" the device's
159 configuration will not be collected. It is highly recommended
160 that comments are made for any router not listed as up, so as to
161 indicate the reason a router is not to be polled, e.g.:
162 dial1.paris;cisco;up;
164 core1.paris;cisco;down;in testing until 5/5/2001.
165 core2.paris;cisco;ticketed;Ticket 6054234, 5/3/2001
166 border1.paris;juniper;up;
167 The script "downreport" in util/ can be used to produce a report
169 of routers in router.db that are not marked "up".
170 [comments]
172 Freeform string to describe the current state of the router.
173 A ``#'' at the beginning of a line is a comment; the entire line is
175 ignored.
176 If a device is deleted from the router.db file, then rancid will clean
178 up by removing the device's config file from $BASEDIR/<group>/configs.
179 The device will be removed from the revision control system. It is
180 possible, in most cases, to resurrect or check-out copies of deleted
181 device configurations.
182
184 $BASEDIR/<group>/router.db
185 Configuration file described here, where <group> is a device
186 group name defined in the variable LIST_OF_GROUPS within
187 $BASEDIR/etc/rancid.conf.
188
190 control_rancid(1), rancid(1), rancid.conf(5)
191
193 In RANCID releases prior to 3.0, router.db used colons (:) as its field
194 separator. This was changed to allow IPv6 addresses to be used in
195 router.db.
196 5 May 2020 router.db(5)