summaryrefslogtreecommitdiffstats
path: root/man/rancid.1
blob: e2695ee9362468fd37e3165580b5ca4514248074 (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
148
149
150
151
.\"
.hys 50
.TH "rancid" "1" "27 February 2008"
.SH NAME
rancid \- Cisco configuration filter
.SH SYNOPSIS
.B rancid
[\fB\-dlV\fP]
(\fB\-f\fP filename | hostname)
.SH DESCRIPTION
.B rancid
is a
.BR perl (1)
script which uses the login scripts (see
.BR clogin (1))
to login to a device, execute commands to display the configuration, etc,
then filters the output for formatting, security, and so on.
.B rancid's
product is a file with the name of it's last argument plus the suffix .new.
For example,
.IR hostname.new .
.PP
There are complementary scripts for other platforms and/or manufacturers
that are supported by
.BR rancid (1).
Briefly, these are:
.sp
.TP 15
.B agmrancid
Cisco Anomaly Guard Module (AGM)
.TP 15
.B arancid
Alteon WebOS switches
.TP
.B brancid
Bay Networks (nortel)
.TP
.B cat5rancid
Cisco catalyst switches
.TP
.B cssrancid
Cisco content services switches
.TP
.B erancid
ADC-kentrox EZ-T3 mux
.TP
.B f10rancid
Force10
.TP
.B f5rancid
F5 BigIPs
.TP
.B fnrancid
Fortinet Firewalls
.TP
.B francid
Foundry and HP procurve OEMs of Foundry
.TP
.B hrancid
HP Procurve Switches
.TP
.B htranicd
Hitachi Routers
.TP
.B jerancid
Juniper Networks E-series
.TP
.B jrancid
Juniper Networks
.TP
.B mrancid
MRTd
.TP
.B nrancid
Netscreen firewalls
.TP
.B nsrancid
Netscaler
.TP
.B nxrancid
Cisco Nexus boxes
.TP
.B prancid
Procket Networks
.TP
.B rivrancid
Riverstone
.TP
.B rrancid
Redback
.TP
.B srancid
SMC switch (some Dell OEMs)
.TP
.B trancid
Netopia sDSL/T1 routers
.TP
.B tntrancid
Lucent TNT
.TP
.B xrancid
Extreme switches
.TP
.B zrancid
Zebra routing software
.PP
The command-line options are as follows:
.TP
.B \-V
Prints package name and version strings.
.TP
.B \-d
Display debugging information.
.\"
.TP
.B \-l
Display somewhat less debugging information.
.\"
.TP
.B \-f
.B rancid
should interpret the next argument as a filename which contains the
output it would normally collect from the device (
.I hostname\c
) with
.IR clogin (1).
.SH "SEE ALSO"
.BR control_rancid (1),
.BR clogin (1),
.BR rancid.conf (5)
.\"
.SH "CAVEATS"
For Catalyst switches running CatOS, type
.B cat5,
the prompt must end with '>'.
.BR clogin (1)
looks for '>' to determine when a login is successful.  For example:
.sp
.in +1i
.nf
cat5k>
cat5k> enable
Password: 
cat5k> (enable) 
.fi
.in -1i
.PP
.B rancid
works on Cisco Catalyst 1900 series switches that are running Enterprise
Edition software.  This software provides a menu at connection time that
allows a command line interface to be used by entering 'K' at the prompt.