summaryrefslogtreecommitdiffstats
path: root/man/rancid.1
blob: 15fca7d2f0cd88ff880c97cc60c3ce90ed728700 (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
.\"
.hys 50
.TH "rancid" "1" "6 Jan 2004"
.SH NAME
rancid \- Cisco configuration filter
.SH SYNOPSIS
.B rancid
[\fB\-dl\fP]
([\c
.BI \-f\ \c
filename]\ \c
| hostname)
.SH DESCRIPTION
.B rancid
is a
.BR perl (1)
script which uses
.BR clogin (1)
to login to a Cisco router, 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, hostname.new.
.PP
There are complementary scripts for
Alteon WebOS switches,
Bay Networks (nortel),
Cisco catalyst switches,
Cisco content services switches,
ADC-kentrox EZ-T3 mux,
Force10,
Foundry,
HP Procurve Switches,
Hitachi Routers,
Juniper Networks E-series,
Juniper Networks,
MRTd,
Procket Networks,
Riverstone,
Redback,
Lucent TNT,
Netscreen firewalls,
Netscaler,
Extreme,
and Zebra routing software
named 
.B arancid,
.B brancid,
.B cat5rancid,
.B cssrancid,
.B erancid,
.B f10rancid,
.B fnrancid,
.B francid,
.B hrancid,
.B htrancid,
.B jerancid,
.B jrancid,
.B mrancid,
.B nrancid,
.B nsrancid,
.B prancid,
.B rivrancid,
.B rrancid,
.B tntrancid,
.B nrancid,
.B xrancid,
and
.B zrancid,
respectively.
.PP
The command-line options are as follows:
.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