1rancid(1) General Commands Manual rancid(1)
2
6 rancid - Cisco configuration filter
7
9 rancid [-dlCV] [-t device_type] (-f filename | hostname)
10 rancid [-dhlCV] -t device_type (-f filename | hostname)
12
14 rancid is a collection of perl(1) scripts which use the login scripts
15 (see clogin(1)) to login to a device, execute commands to display the
16 configuration, etc, then filters the output for formatting, security,
17 and so forth. rancid's product is a file with the name of it's last
18 argument plus the suffix .new. For example, hostname.new.
19 rancid is a perl(1) script that operates much like the vendor-specific
21 rancid script of pre-3.0 releases, but is generic and will eventually
22 obsolete the vendor-specific rancid scripts. It uses the device_type
23 specified with the -t option to look-up a device description (see
24 rancid.types.conf(5)) that defines what it does to collect and process
25 device information.
26 There are scripts complementary to rancid for other platforms and/or
28 manufacturers that are supported by rancid(1). Briefly, these are:
29 agmrancid Cisco Anomaly Guard Module (AGM)
32 arancid Alteon WebOS switches
34 arrancid Arista Networks devices
36 brancid Bay Networks (nortel)
38 cat5rancid Cisco catalyst switches
40 cssrancid Cisco content services switches
42 erancid ADC-kentrox EZ-T3 mux
44 f10rancid Force10
46 f5rancid F5 BigIPs
48 fnrancid Fortinet Firewalls
50 rancid The generic rancid script; supporting Allied Telesis AW+
52 devices, Arbor Networks Appliances, Ciena Waverserver,
53 Cisco IOS, Cisco IOS-XR, Cisco NX-OS, Cisco WLC, (some)
54 Dell switches, Extreme switches, Foundry (aka some
55 Brocade) devices, Juniper JUNOS, Nokia (Alcatel-Lucent)
56 SR OS, and UBNT Edgemax and EdgeRouter. It uses the
57 device O/S modules for parsing routines as determined by
58 the rancid.types.conf(5) file(s). Also see rancid(3)
59 for details.
60 hrancid HP Procurve Switches
62 htranicd Hitachi Routers
64 jerancid Juniper Networks E-series
66 mrancid MRTd
68 mtrancid Mikrotik routesrs
70 nrancid Netscreen firewalls
72 nsrancid Netscaler
74 prancid Procket Networks
76 rivrancid Riverstone
78 rrancid Redback
80 srancid SMC switch (some Dell OEMs)
82 trancid Netopia sDSL/T1 routers
84 xirancid Xirrus arrays
86 zrancid Zebra routing software
88 The command-line options are as follows:
90 -C Prints the login command that would be used to collect data from
92 the device.
93 -V Prints package name and version strings.
95 -d Display debugging information.
97 -h Display a usage line and exit.
99 -l Display somewhat less debugging information.
101 -t Device type, of the given host or file, that is defined in
103 rancid.types.base or rancid.types.conf .
104 -f rancid should interpret the next argument as a filename which
106 contains the output it would normally collect from the device (
107 hostname) with clogin(1).
108
110 control_rancid(1), clogin(1), rancid.conf(5), rancid.types.conf(5),
111 rancid(3)
112
114 Cisco IOS offers a DHCP server that maintains a text database which can
115 be stored remotely or on local storage. If stored locally, the file
116 changes constantly and causes constant diffs from rancid. If this
117 file's name ('ip dhcp database') matches the regex
118 dhcp_[^[:space:].].txt, it will be filtered. For Catalyst switches
119 running CatOS, type cat5, the prompt must end with '>'. clogin(1)
120 looks for '>' to determine when a login is successful. For example:
121 cat5k>
123 cat5k> enable
124 Password:
125 cat5k> (enable)
126 rancid works on Cisco Catalyst 1900 series switches that are running
128 Enterprise Edition software. This software provides a menu at
129 connection time that allows a command line interface to be used by
130 entering 'K' at the prompt.
131 22 January 2019 rancid(1)