summaryrefslogtreecommitdiffstats
path: root/man/router.db.5
blob: a568243437ddf9b5cf51de76415f5cdb2acd6b76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.\"
.hys 50
.TH "router.db" "5" "22 Jan 2001"
.SH NAME
router.db \- rancid group configuration file
.SH DESCRIPTION
.B router.db
contains information for devices which are members of a rancid group.
.IR control_rancid (1)
reads this file to compile a list of devices which it should collect.
.\"
.SH SYNTAX
One device is listed per-line, where the syntax is:
.PP
.in +1i
.nf
<device_name>:<device_type>:<state>[:comments]
.fi
.in -1i
.PP
For example:
.in +1i
.nf
scooby.shrubbery.net:cisco:up
.fi
.in -1i
.PP
.\"
The fields are as follows:
.TP
.B <device_name>
The name of the device, which must resolve via
.I gethostbyname\c
, used as the argument to
.IR telnet (1),
.IR rsh (1),
or
.IR 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
\fI$BASEDIR/<group>/configs\fR.
.sp
Experience has shown that using the device's FQDN (Fully Qualified
Domain Name) works best, as in the example above.
.\"
.TP
.B <device_type>
The type of device from the set:
.RS 8n
.TP
.B alteon
An Alteon WebOS switches.
.TP
.B baynet
A Bay Networks router.
.TP
.B cat5
A cisco catalyst series 5000 and 4000 switches (ie: running the catalyst OS,
not IOS).
.TP
.B cisco
A cisco router, PIX, or switch such as the 3500XL or 6000 running IOS (or
IOS-like) OS.
.TP
.B extreme
An Extreme switch.
.TP
.B ezt3
An ADC-Kentrox EZ-T3 mux.
.TP
.B force10
A Force10 router.
.TP
.B foundry
A Foundry router, switch, or router-switch.  This includes HP
Procurve switches that are OEMs of Foundry products, such as the
HP9304M.
.TP
.B hp
A HP Procurve switch such as the 2524 or 4108 procurve switches.  Also see the
.B foundry
type.
.TP
.B juniper
A Juniper router.
.TP
.B mrtd
A host running the (merit) MRTd daemon.
.TP
.ID 15n
.B redback
A Redback router, NAS, etc.
.RE
.\"
.TP
.B <state>
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.:
.sp
dial1.paris:cisco:up:
.br
core1.paris:cisco:down:in testing until 5/5/2001.
.br
core2.paris:cisco:ticketed:Ticket 6054234, 5/3/2001
.br
border1.paris:juniper:up:
.sp
The script "downreport" in util/ can be used to produce a
report of routers in router.db that are not marked "up".
.PP
.TP
.B [comments]
Freeform string to describe the current state of the router.
.PP
A ``#'' at the begining of a line is a comment; the entire line is
ignored.
.PP
If you delete a device from the 
.B router.db
file, then
.B rancid
will clean up by removing the device's config file from
\fI$BASEDIR/<group>/configs\fR.
The
.IR cvs (1)
information for the device will be moved to 
.IR cvs (1)'s
Attic directory (using
.IR "cvs delete").
.PP
.SH FILES
.ta \w'xBASEDIR/<group>/router.db  'u
.TP
.B $BASEDIR/<group>/router.db
Configuration file described here, where <group> is a device group name
defined in the variable
.I LIST_OF_GROUPS
within \fI$BASEDIR/bin/env\fR.
.El
.SH SEE ALSO
.BR control_rancid (1),
.BR env (5),
.BR rancid (1)