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 arista An Arista Networks device.
43 avocent
45 An Avocent Cyclades console server.
46 baynet A Bay Networks router.
48 cat5 A Cisco catalyst series 5000 and 4000 switches (i.e.:
50 running the catalyst OS, not IOS).
51 cisco A Cisco router, PIX, or switch such as the 3500XL or
53 6000 running IOS (or IOS-like) OS, but not IOS-XR.
54 cisco-nx
56 A Cisco Nexus switch/router.
57 cisco-xr
59 A Cisco device running IOS-XR.
60 css A Cisco content services switch.
62 enterasys
64 An enterasys NAS. This is currently an alias for the
65 riverstone device type.
66 erx A Juniper E-series edge router.
68 extreme
70 An Extreme switch.
71 ezt3 An ADC-Kentrox EZ-T3 mux.
73 f5 A F5 BigIP switch.
75 force10
77 A Force10 router.
78 fortigate
80 A Fortinet firewall.
81 foundry
83 A Foundry router, switch, or router-switch. This
84 includes HP Procurve switches that are OEMs of Foundry
85 products, such as the HP9304M.
86 hitachi
88 A Hitachi router.
89 hp A HP Procurve switch such as the 2524 or 4108 procurve
91 switches. Also see the foundry type.
92 juniper
94 A Juniper router.
95 mrtd A host running the (Merit) MRTd daemon.
97 netscalar
99 A Netscalar load balancer.
100 netscreen
102 A Netscreen firewall.
103 procket
105 A Procket router.
106 redback
108 A Redback router, NAS, etc.
109 riverstone
111 A Riverstone NAS or Cabletron (starting with version
112 ~9.0.3) router.
113 smc A SMC switch (some Dell OEMs).
115 tnt A Lucent TNT.
117 zebra Zebra routing software.
119 <state>
121 The state is either "up", or some other arbitrary value, e.g.
122 "down". If the device is not marked "up" the device's
123 configuration will not be collected. It is highly recommended
124 that comments are made for any router not listed as up, so as to
125 indicate the reason a router is not to be polled, e.g.:
126 dial1.paris:cisco:up:
128 core1.paris:cisco:down:in testing until 5/5/2001.
129 core2.paris:cisco:ticketed:Ticket 6054234, 5/3/2001
130 border1.paris:juniper:up:
131 The script "downreport" in util/ can be used to produce a report
133 of routers in router.db that are not marked "up".
134 [comments]
136 Freeform string to describe the current state of the router.
137 A ``#'' at the begining of a line is a comment; the entire line is
139 ignored.
140 If a device is deleted from the router.db file, then rancid will clean
142 up by removing the device's config file from $BASEDIR/<group>/configs.
143 The device will be removed from the revision control system. It is
144 possible, in most cases, to resurrect or check-out copies of deleted
145 device configurations.
146
148 $BASEDIR/<group>/router.db
149 Configuration file described here, where <group> is a device
150 group name defined in the variable LIST_OF_GROUPS within
151 $BASEDIR/etc/rancid.conf.
152
154 control_rancid(1), rancid(1), rancid.conf(5)
155 8 April 2010 router.db(5)